Node Boilerplate

Node Boilerplate is used for quickly start any node project.

Features!

The overriding design goal for nodeboiler plate is to ease up the project setup reduce project development time improve team productivity

Node Boilerplate uses a number of open projects to work properly:

Node - Open-source, cross-platform JavaScript run-time environment
Microsoft TypeScript - Strict syntactical superset of JavaScript
InversifyJS - A powerful and lightweight inversion of control container
Typeorm - Active Record and Data Mapper patterns supports MySQL / MariaDB / Postgres / SQLite / Microsoft SQL Server / Oracle / sql.js / MongoDB
Express - Fast, unopinionated, minimalist web framework
Passport - Simple, unobtrusive authentication
Swagger - Specification for documenting REST API
TypeDoc - A documentation generator for TypeScript projects
Jest - JavaScript testing library

Node Boilerplate requires Node v10.16 to run. It also requires to connect to any Relational database.

Install the dependencies and devDependencies.

$ npm install

Check for any linting and compiletime error.

$ npm run check

Fix linting errors.

$ npm run fix

Create TypeDoc doccumentation

$ npm run doc

Run tests

$ npm t

Look for test coverage

$ npm run coverage

Development mode

$ npm run dev

Generate Migration

$ npm run autoMigrate

Create Build

$ npm run compile

Delete Build Folder

$ npm run clean

Server run, use Forever or PM2

$ forever start ./build/src/index.js
$ pm2 start ./build/src/index.js