⚠️ This is a Work In Progress. Don't use this is production.
Due to this package being private, npm has to retrieve it from GitHub Packages registry instead of npm's.
For that to be possible, a personal access token with read:packages
scope is required. Read GitHub's documentation for additional information.
npm install --global @wycreative/generator-starter
Open a terminal pointed to the directory you want to start a new project and run:
yo @wycreative/starter
Then answer the prompts that will appear in the terminal. After that, the project files will be generated.
With the repository cloned locally, open the terminal pointed to the repository's root and run:
npm install
Then, to make the local version of the generator available as a global package in the system, with the terminal still pointing to the repository's root, run the following to create an alias:
npm link
Now you can use it in any directory as described in Usage. All changes made in the generator will reflect immediately in the globally installed alias.
Command | Description |
---|---|
npm test |
Checks for code-style issues. |