emmanuelnwankwo / auroramay

Description

Auror May is a codename for a simple CRUD RESTful API using Nest framework

Documentation (Live)

Swagger doc on Heroku

Installation

# clone the repo
$ git clone https://github.com/emmanuelnwankwo/auroramay && cd auroramay

# install dependencies
$ npm install

Running the app

# create env file, enter PORT and Mongodb connection string
$ touch .env && cp env.example .env

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov