Yo Norgate-AV - Project Generator
A Yeoman generator to bootstrap various projects 🚀🚀🚀
Contents 📖
Installation ⚡
Install Yeoman and the Norgate AV generator:
npm install -g yo generator-norgate-av
# or
yarn global add yo generator-norgate-av
# or
pnpm add -g yo generator-norgate-av
Usage 🚀
The Yeoman generator will walk you through the steps required to create your project prompting for the required information.
To launch the generator simply type:
yo norgate-av
Command Line 👨💻
Usage:
yo norgate-av:app [<destination>] [options]
Generates project boilerplates of various types ready for development.
Options:
-h, --help # Print the generator's options and usage
--skip-cache # Do not remember prompt answers Default: false
--skip-install # Do not automatically install dependencies Default: false
--force-install # Fail on install dependencies error Default: false
--ask-answered # Show prompts for already configured options Default: false
-y, --yes # Quick mode, skip all optional prompts and use defaults
-o, --open # Open the generated project in Visual Studio Code
-t, --projectType # crestron-simpl, typescript, javascript, cli, html, python...
-n, --projectDisplayName # Display name of the project
--projectId # Id of the project
--projectDescription # Description of the project
-p, --pkg # Package manager to use. Possible values, "pnpm", "yarn" or "npm"
-g, --git # Initialize a git repo
Arguments:
destination #
The folder to create the project in, absolute or relative to the current working directory.
Use '.' for the current folder. If not provided, defaults to a folder with the project display name.
Type: String Required: false
Example usages:
yo norgate-av # Create an project in a folder with the projects's name.
yo norgate-av . -o # Create an project in current folder and open with Visual Studio Code.
yo norgate-av cowbell -t ts -y # Create an TypeScript project in './cowbell', skip prompts, use defaults.
yo norgate-av dopephish -t js -g # Create an JavaScript project in './dopephish', initialize a git repository.
Team ⚽
This project is maintained by the following person(s) and a bunch of awesome contributors.
Damien Butt |
Contributors ✨
Thanks go to these awesome people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Check out the contributing guide for more information.