node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »

project-starter

project-starter Build Status

a cli tool to help you start a new project

Installation

$ [sudo] npm install project-starter -g

Preview

See the output of this project here

Features

The generated project uses the following technologies:

Client

Server

  • Express Fast, minimalist web framework for Node.js
  • Socket.io Socket.IO enables real-time bidirectional event-based communication
  • Mongoose mongodb object modeling for node.js
  • express-async-router An Express Router wrapper which automatically manage Promise.
  • express-json-error-handler Error handler for express JSON APIs
  • express-jwt express middleware that validates a JsonWebToken
  • jsonwebtoken JsonWebToken implementation for node.js
  • express-static-gzip Simple wrapper on top of express.static, that allows serving pre-gzipped files
  • passport Passport is authentication middleware for Node.js
  • mongoose-plugin-seed Mongoose plugin to seed your models
  • socketio-jwt Authenticate socket.io incoming connections with JWTs
  • nodemon Nodemon is a utility that will monitor for any changes in your source and automatically restart your server
  • bunyan a simple and fast JSON logging module for node.js services
  • env-bunyan Bunyan wrapper with environment variables

Utilities

Usage

Bootstrap a new project repository with these steps:

  • Clone your repository

  • run npm init with your preferred values (if no package json is found, will run npm init -y for you)

  • run project-starter in the folder

CLI

$ project-starter
 
   project-starter 0.0.0 - a cli tool to help you start a new project
     
   USAGE
 
     project-starter [path]
 
   ARGUMENTS
 
     [path]      Directory to initialize      optional      default: "/path/to/cwd"
 
   OPTIONS
 
     -n, --name      Name of your project      optional      
 
   GLOBAL OPTIONS
 
     -h, --help         Display help                                      
     -V, --version      Display version                                   
     --no-color         Disable colors                                    
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages    

Example

git clone https://github.com/me/my-project
cd my-project
project-starter

License

MIT