VSinerva/freesewing
1
0
Fork 0
Code Activity

update kickstart and tips

Browse source
This commit is contained in:
Enoch Riese 2023-07-28 12:56:14 -05:00
parent 5d5b247b77
commit 1521d55d16
2 changed files with 27 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

8
package.json
View file

@ -16,8 +16,8 @@
"tips": "node scripts/help.mjs",
"lab": "cd sites/lab && yarn start",
"lab-debug": "cd sites/lab && yarn start-debug",
"kickstart": "npx yarn install && yarn reconfigure && yarn buildall && yarn prepare && yarn tips",
"kickstart:windows": "npx yarn install && yarn wbuildall && yarn prepare && yarn tips",
"kickstart": "npx yarn install && yarn prepare && yarn tips",
"kickstart:windows": "npx yarn install && yarn prepare && yarn tips",
"cleanall": "lerna run clean",
"test": "lerna run test",
"e2e": "lerna run e2e",
@ -26,8 +26,8 @@
"sitebuildconfigure": "SITEBUILD=1 node --experimental-json-modules --no-warnings scripts/reconfigure.mjs",
"prerelease": "lerna version --no-git-tag-version --no-push && yarn reconfigure && yarn buildall",
"buildall": "lerna run build:all",
"build": "yarn build:all",
"wbuild": "yarn wbuild:all",
"build": "yarn buildall",
"wbuild": "lerna run wbuild:all",
"testall": "node scripts/testall.js",
"lint": "LINTER=1 lerna run --no-bail lint -- ",
"qa": "yarn qa:prettier && yarn qa:lint",

27
scripts/help.mjs
View file

@ -31,14 +31,22 @@ console.log(`
${chalk.blue('yarn kickstart')}
It will install and link all dependencies, and link them together.
It will also run ${chalk.blue('yarn reconfigure')} which you can run yourself at any time to (re)configure all packages and dependencies.
It will install and link all dependencies.
If something goes wrong in the configuration, you can run
${chalk.blue('yarn reconfigure')}
It will (re)configure all packages and dependencies.
${chalk.bold.yellow('🛠️ Starting the development environment')}
${chalk.gray('≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡')}
Our development environment for ${chalk.bold('designs')} and ${chalk.bold('plugins')} lives in ${chalk.green('sites/lab')}
Our development environment for ${chalk.bold('designs')} and ${chalk.bold(
'plugins'
)} lives in ${chalk.green('sites/lab')}
We refer to it as ${chalk.bold('the FreeSewing lab')}.
It can display any design in this repository and will hot-reload any changes you make to a design.
@ -59,6 +67,15 @@ console.log(`
It will ask you some questions, and set everything up for you, and add your design to the lab.
If you later need to add more dependencies to your design, add them in ${chalk.green(
'config/dependencies.yaml'
)}, then run
${chalk.blue('yarn reconfigure')}
They will be added to your design's ${chalk.green('package.json')}
${chalk.bold.yellow('🤔 More info & help')}
${chalk.gray('≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡')}
@ -66,7 +83,9 @@ console.log(`
${chalk.green('https://freesewing.dev/')}
Our community is on Discord. The ${chalk.bold('development-help')} channel is a good place to start:
Our community is on Discord. The ${chalk.bold(
'development-help'
)} channel is a good place to start:
${chalk.green('https://discord.freesewing.dev/')}