A simple REST API to support Coding Coach (alpha).
$ yarn install
cp .env.example .env
Make sure to set the new .env
file up with the appropriate variables
The following command can be used to run both, the api and the database, in separate containers (e.g. if you don't have node on your machine):
# start both containers
$ docker-compose up
# use ctrl-c to stop both containers
The following steps can be used to run the database in a container and the api locally:
# start mongo DB in a container in the background
$ docker-compose -f docker-compose-db.yml up -d
# development
$ yarn start
# development in watch mode
$ yarn start:dev
# production mode
$ yarn start:prod
We are using swagger to document the endpoints, after running the project just open your browser and go to http://localhost:3000/docs/
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov