Mercavus

Mercavus Backend Challenge

Requirements

Built With

• Node.js (v12.14.1)
• Typescript
• Express
• Mongoose
• Jest with Supertest for unit testing and coverage

RUNNING APP WITH DOCKER

Docker & docker-compose must be installed

$ docker-compose up --build

RUNNING APP WITHOUT DOCKER

Dependency Installation

$ yarn 

Running the app

# copy env.example to env (you can change the default port which is 3000)
$ cp .env.example env

change MONGODB_URL to your mongodb instance connection URL (Mongodb should be installed and running)

# build app
$ yarn build

# start app
$ yarn start

# app is running on
http://localhost:3000/

Testing the app

# unit tests with coverage
$ yarn test

Docs

# swagger api doc
http://localhost:3000/api/v1/docs/

unit tests with coverage report