README.md

Express REST API Boilerplate

Boilerplate/Generator/Starter Project for building RESTful APIs and microservices using Node.js, Express and Mongoose

Requirements

• Node v8+
• Yarn

Features

• Uses yarn
• Logging with morgan
• Error handler with rollbar
• Tests with jest and supertest
• Express + Mongoose (mongoose)
• Consistent coding styles with editorconfig
• Continuous integration support with circleci
• Authentication and Authorization with passport
• Uses helmet to set some HTTP headers for security
• Load environment variables from .env files with dotenv

Getting Started

Install dependencies:

yarn

Add dependencies:

yarn add <package-name>

Set environment variables:

cp .env.example .env

Running Locally

yarn dev

Test

# run all tests with Jest
yarn test