Awesome
Boilerplate Generator Template
A simple Yeoman generator using Git submodules to clone over a boilerplate hosted elsewhere on GitHub.
Getting started
These are a few things you will want to customize:
git submodule add YOUR-REPO-ON-GITHUB app/templates
- README.md: Anywhere you see 'boilerplate' should be customized with the name of the generator you are creating (e.g generator-awesome)
- package.json: Customize the repository, author and dependencies.
You can then test out your generator without pushing to npm using npm install -g
and
yo awesome
(where awesome is the name of your generator).
Usage (for your end-users)
- Install Yeoman:
npm install -g yo
- Install the generator:
npm install -g generator-boilerplate
- Run:
yo boilerplate
- Start using Boilerplate