generator-projekt v0.1.2
Generator-projekt
An opinionated boilerplate generator for rapid development
Installation
Install Yeoman and generator-projekt using npm or Yarn:
npm i -g yo generator-projekt
yarn add --global yo generator-projekt
Usage
Basic Usage
The simplest usage is from the command line using Yeoman:
yo generator-projekt
You can also set option values, or wait to be prompted by the CLI.
Options
Usage: yo generator-projekt options
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 --name # Project name Default: current package name --description # Project description Default: current package description --githubAccount # GitHub username or organization --repositoryName # Name of the GitHub repository --authorName # Author name --authorUrl # Author url
Sub-Generators
Development
Prerequisites
Before starting development, you must have:
node
>= 11.10.0npm
>= 6.9.0yeoman
Install these from the command line:
brew upgrade node
npm i -g npm yo
Setup
Clone the repo and install the dependencies:
git clone https://github.com/nielse63/generator-projekt.git
cd generator-projekt
npm i
Testing
Once you have made your desired changes, run the full test suite:
npm test
This will lint the files and run all jest tests.
Contributing
To submit your code create a pull request following the existing template.
If you find any issues or want to request a new feature, please create an issue.
License
Apache-2.0 © Erik Nielsen