This is a Vulcan template to make boilerplate code from.
- Install Vulcan globally.
npm i -g @cspruit/vulcan. - Clone this repository on your machine
- In the directory this repo has been cloned to, run
vulcan linkto link this to your global list of templates. - Navigate to the directory this template will be generated in.
- Run
vulcan generate libraryand continue in the interactive prompt. - If successful, you now have boilerplate ready to go for your new project!
Template for README.md below. Remember to clean this up when generated.
This is a Vulcan template to make boilerplate code from.
- Install Vulcan globally.
npm i -g @cspruit/vulcan. - Clone this repository on your machine
- In the directory this repo has been cloned to, run
vulcan linkto link this to your global list of templates. - Navigate to the directory this template will be generated in.
- Run
vulcan generate {{pkg}}and continue in the interactive prompt. - If successful, you now have boilerplate ready to go for your new project!
Template for README.md below. Remember to clean this up when generated.
---# {{pkg}}
This is a Vulcan template to make boilerplate code from.
- Install Vulcan globally.
npm i -g @cspruit/vulcan. - Clone this repository on your machine
- In the directory this repo has been cloned to, run
vulcan linkto link this to your global list of templates. - Navigate to the directory this template will be generated in.
- Run
vulcan generate {{pkg}}and continue in the interactive prompt. - If successful, you now have boilerplate ready to go for your new project!
Template for README.md below. Remember to clean this up when generated.
---
{{description}}
- Install by running
npm install --save-dev {{pkg}}in the same directory as the package.json file lives.
All contributions, suggestions, and issues are welcome!
Check out the Issues page. In general anything listed is up for grabs, though bugs tend to be more detailed than enhancements and might be better to pick up if starting out.
This project uses GPL 3.0.