starter-kit
v2.2.0
Published
A quick command-line utility for NodeJS that helps quickly spin up new projects.
Downloads
29
Maintainers
Readme
StarterKit
A command-line utility for Node that gives quick access to starter-kits that help you spin up a project easily. Designed for teams that desire consistency but require flexibility from project to project.
Install
npm install starter-kit -g
Basic Usage
mkdir your_directory
cd your_directory
starterkit use starter-kit
As a general rule, every Starterkit has a ./bin/bootstrap
file that sets up
the requirements of that Starterkit, and a ./bin/dev-start
file that begins
what development process is needed.
Starter Kits
- frontend-starter
- react-starter
- react-express-starter
- sailsjs-starter
- express-jwt-starter
- email-starter
- express-starter
- koa-v2-starter
- koa-graphql-starter
Additional Libraries
You can install any library available on Bower or
NPM through the
use
command as well! Simply add --bower
and/or --npm
as an option on
your command.
Examples:
starterkit use frontend-starter --bower jquery,bourbon,neat
starterkit use react-starter --bower bourbon --npm jquery,radium
Building a Starter Kit
Want to build a starter kit? Awesome! It's really rather simple. Just follow these principles, build your starter kit, and then submit a pull-request with a link to your wonderful starter kit.
Starter Kit Principles
- Only the bare necessities. People shouldn't feel the need to delete anything in a starter kit.
- ./bin/bootstrap is the only way to setup. The starterkit cli calls
./bin/bootstrap
when installing starter kits, so chances are the setup will just fail. The idea is that a user should not have to run a single line of code to get their project ready to go after using the starter kit.