Express REST Starter

This project starter includes everything you need to get up and running with a quick REST backend.

Features

MongoDB
local Authentication and JWT Authentication
REST api is documented with Swagger (json format)
pre-commit/pre-push hooks for testing
Code coverage and testing through Jest and Supertest
Travis CI integration
Heroku integration

setup your .env with your local dev environment.
for production setup environment variables in travis and heroku

Installation

npm install
copy .env.example to .env and set your environment variables:

DATABASE_URL, TEST_DATABASE_URL: mongodb urls
PORT: defaults to 8080
JWT_SECRET: defaults to S3cr3t!
JWT_EXPIRY: defaults to 7d

Update .travis.yml per instructions below (Travis CI, Heroku setup)
Add your models, routes and secure your endpoint by passing jwtAuth middleware example:
```
app.get('/my-protected-endpoint', jwtAuth, (req, res) => {...});
```

Travis CI, Heroku setup

sign up for an account at the TravisCI website
login to Travis and go to your account repositories page and switch your repo to 'on'
install Travis CI CLI and install Heroku CLI
Login and integrate with Heroku by running travis login and supply github username/password
run travis setup heroku
run heroku create
after your changes run git push heroku master
run heroku ps:scale web=1 to startup dyno on server

Package.json Scripts and Usage

start: default command which calls npm run prod
prod: starts server with prod configurations
dev: starts server using nodemon which watches files for updates and reloads
test: runs all unit tests with code coverage using jest