NodeJS Express Boilerplate

• NodeJS boilerplate on top of express without the need to use Babel

Built-in modules/libraries

• ExpressJS - NodeJS HTTP Framework
• Sequelize - NodeJS ORM
• Mogran - Express logger
• Winston - Logs transport to console/file. Logrotate daily added
• dotenv-safe - environment manager
• MochaJS - Testing framework
• Eslint - Base:AirBnB
• Swagger - Define/Document APIs

and more

Requirements

• NodeJS v7.0+
• Yarn
• Docker, docker compose/swarm for prod to maximize nginx caching & security(optional)

Install

$ git clone https://github.com/shierro/node-express-boilerplate <project_name>
$ cd <project_name> && npm i

Set your Environment vars (important)

$ cp .env.example .env

Change .env vars with your env

Dev mode

$ yarn dev

Run unit test

$ yarn test

Generate test coverage

$ yarn run cover

Prod mode w/ docker-compose

$ docker-compose up -d

Uses sequelize & sequelize-auto to handle the model layer

$ yarn generate:models

Built-in Application Monitoring

• http://localhost:/healthcheck
• http://localhost:/version

Swagger Specs

• http://localhost:/specs