Skip to content

⌛️ Express boilerplate for building RESTful APIs

License

Notifications You must be signed in to change notification settings

nixpench/express-rest-boilerplate

This branch is 55 commits behind danielfsousa/express-rest-boilerplate:main.

Folders and files

NameName
Last commit message
Last commit date
Oct 4, 2017
Nov 25, 2019
Oct 3, 2019
Jul 18, 2017
Nov 25, 2019
Jul 18, 2017
Jul 18, 2017
Mar 18, 2018
Nov 25, 2019
Oct 4, 2017
Oct 1, 2019
Oct 1, 2019
Jul 18, 2017
Jul 18, 2017
Oct 1, 2019
Jul 18, 2017
Oct 9, 2018
Oct 9, 2018
Sep 25, 2018
Jul 18, 2017
Sep 13, 2020
Aug 31, 2020

Repository files navigation

Express ES2017 REST API Boilerplate

PRs Welcome npm version Build Status Coverage Status

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

Features

  • No transpilers, just vanilla javascript
  • ES2017 latest features like Async/Await
  • CORS enabled
  • Uses yarn
  • Express + MongoDB (Mongoose)
  • Consistent coding styles with editorconfig
  • Docker support
  • Uses helmet to set some HTTP headers for security
  • Load environment variables from .env files with dotenv
  • Request validation with joi
  • 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

Getting Started

Clone the repo and make it yours:

git clone --depth 1 https://github.com/danielfsousa/express-rest-es2017-boilerplate
cd express-rest-es2017-boilerplate
rm -rf .git

Install dependencies:

yarn

Set environment variables:

cp .env.example .env

Running Locally

yarn dev

Running in Production

yarn start

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

Validate

# run lint and tests
yarn validate

Logs

# show logs in production
pm2 logs

Documentation

# generate and open api documentation
yarn docs

Docker

# run container locally
yarn docker:dev

# run container in production
yarn docker:prod

# run tests
yarn docker:test

Deploy

Set your server ip:

DEPLOY_SERVER=127.0.0.1

Replace my Docker username with yours:

nano deploy.sh

Run deploy script:

yarn deploy

Tutorials

Inspirations

License

MIT License - Daniel Sousa

About

⌛️ Express boilerplate for building RESTful APIs

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 62.2%
  • Pug 20.3%
  • HTML 16.6%
  • Other 0.9%