Boilerplate for REST Microservice in NodeJS

Features

• REST API with Swagger UI
• Middlewares (compress, helmet, cors, favicon, body parser and static)
• Unit Test with Jest
• ES6, ESLint
• CI with Travis, Docker Build

Installation

# install dependencies
npm install

Running the tests

# run all tests
npm test

# run test coverage
npm run coverage

Build and Run

# serve with hot reload at localhost:3030
npm start

# build for production with minification
npm run build

Docker support

Build docker image

bash Dockerbuild.sh

Run docker container

docker run -d --name micro-rest -p 3030:3030 jsboilerplates/micro-rest

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details