nodestarter

nodestarter

A Node.js Project Initialiser/Generator/Scaffolder.

Create a basic Node.js project using a scaffold template.

Install

You can install nodestarter using npm as a Global module.

$ npm install -g nodestarter

Usage

$ nodestarter [Options]

Options
    --name           | The name of the project/package (required)
    --author         | The name of the project/package author (required)
    --email          | The email of the project/package author (required)
    [--website]      | The website of the project/package author (optional)
    --repo           | The git repository URL (required)
    [--version]      | The version to initialise the project/package at (optional)
    [--templatePath] | A custom set of template files (optional)
    [--output]       | A custom directory to save the project/package in (optional)
    [--private]      | Is this project/package private? [true,false] (optional)

Contributing

Feel free to make changes and submit a PR. I will be expanding this project over time.

Please ensure that your code conforms to the jshint file provided.

Issues?

Please raise an issue on GitHub with as much information as possible and the steps to replicate (if possible).

License

The MIT License (MIT)

Copyright (c) 2015 Matt Major

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.