Node project boilerplate

Stack

• Node, Express, Passport
• MongoDB/Mongoose
• Handlebars
• Jest

Features

Out of the box solution with MVC, Authentication and Authorization, Rails-like routes,...

Table of contents:

• Installation
• Usage
  • Development
  • Testing
• Production
• API Documentation
• Contributing

Installation

Make sure yarn is installed globally

Always use yarn instead of npm.

$ yarn

Install a dependecy

$ yarn add <package-name>

Remove a dependeny

$ yarn remove <package-name>

Usage

Note: make sure your mongodb server is running

Development

Start the project on your development machine.

# cd into the project directory
$ npm start

Testing

Test locally on your develompent machine.

# cd into the project directory
$ npm test