x249/node-api

# Node API

[![Build Status](https://travis-ci.org/x249/node-api.svg?branch=master)](https://travis-ci.org/x249/node-api)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9aca11d1b2f94ec0a36efcb9c4b67d00)](https://www.codacy.com/manual/phr3nzy/node-api?utm_source=github.com&utm_medium=referral&utm_content=x249/node-api&utm_campaign=Badge_Grade)
[![Maintainability](https://api.codeclimate.com/v1/badges/1cf1f94063ea50a4b138/maintainability)](https://codeclimate.com/github/x249/node-api/maintainability)
[![BCH compliance](https://bettercodehub.com/edge/badge/x249/node-api?branch=master)](https://bettercodehub.com/)
[![Coverage Status](https://coveralls.io/repos/github/x249/node-api/badge.svg?branch=master)](https://coveralls.io/github/x249/node-api?branch=master)
![GitHub Release Date](https://img.shields.io/github/release-date/x249/node-api.svg?style=flat-square)
![GitHub package.json version](https://img.shields.io/github/package-json/v/x249/node-api.svg?style=flat-square)
![GitHub](https://img.shields.io/github/license/x249/node-api.svg)

> Backend API using the latest technologies and standards. Built to scale

## Features

-   [x] RESTful Architecture
-   [x] Easy-to-read code
-   [x] Built with **Scalability** in mind
-   [x] TypeScript
-   [x] Express
-   [x] MongoDB
-   [X] Docker
-   [x] Process Management and Clustering using [PM2](http://pm2.keymetrics.io/)
-   [x] Unit and Integration testing ready
-   [x] API Documentation using [SwaggerUI](https://swagger.io/tools/swagger-ui/)
-   [x] Authentication and Authorization (JWT and Role based)
-   [x] Middleware Handling
-   [x] Error Handling
-   [x] Security Headers (Rate limiting, CORS, XSS, CSRF\*)

(\* not yet implemented)

## Requirements

-   Node >= 8.16.1
-   NPM >= 6.4.1
-   Yarn >= 1.15.2
-   Docker-Compose >= 1.24.0

## Build Setup

```bash
# run using docker
$ docker-compose up -d

# install dependencies
$ yarn install

# serve with hot reload at localhost:4000
$ yarn dev

# run tests
$ yarn test

# build for production and launch server
$ yarn prod
```

## Enivronment Variables

```env
SECRET # for JWT encoding
API_VER # current version of the API
DB_URL # url for the mongo database
```

## License

GNU General Public License v3.0