DenisRupp/API-express-starter

Starter for node.js REST API using Express, Sequelize, Mocha

Express REST API Starter with postgres

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

Features

• No transpilers, just vanilla javascript
• ES2017 latest features like Async/Await
• CORS enabled
• Uses yarn
• Express + Postgres (Sequelize)
• Request validation (express validator
• Consistent coding styles with editorconfig
• Uses helmet to set some HTTP headers for security
• Load environment variables from .env files with dotenv
• Gzip compression with compression
• Linting with eslint
• Tests with mocha, chai and sinon
• Code coverage with istanbul and coveralls
• Git hooks with husky
• Logging with morgan
• Authentication and Authorization with passport
• API documentation generation with apidoc
• Continuous integration support with travisCI
• Monitoring with pm2

Requirements

• Node v8.10
• Yarn
• PM2

Getting Started

Clone the repo and make it yours:

git clone --depth 1 https://github.com/DenisRupp/express-starter
cd express-starter
rm -rf .git

Install dependencies:

yarn

Set environment variables:

cp .env.example .env

Set database configuration:

cp src/database/config.example.js src/database/config.js

Crete database

sequelize db:create --env development

Running Locally

yarn local

Running in Production

yarn start

Database commands

# run all migrations
yarn migrate

# run all seeds
yarn seeds

# generate new migration
sequelize migration:generate --name new-migration

# generate new seed
sequelize seed:generate --name new-seeds

More commands here.

Lint

# lint code with ESLint
yarn lint

# try to fix ESLint errors
yarn lint:fix

# lint and watch for changes
yarn lint:watch

Test

# run all tests with Mocha
yarn test

# run unit tests
yarn test:unit

# run integration tests
yarn test:integration

# run all tests and watch for changes
yarn test:watch

# open nyc test coverage reports
yarn coverage

Logs

# show logs in production
pm2 logs

Deploy

# deploy to dev
pm2 deploy dev

Documentation

# generate and open api documentation
yarn docs

Inspired by danielfsousa