NestJS App that allows to set movies as favorite and to create comments associated with a movie.
- Node.js v16 or higher
- Typescript v4.4 or higher
- NestJS CLI
- MongoDB v6
- npm 6 or higher
$ npm install
First you need a proper .env file, you will find an example with the environment variables required to start the project.
cp .env.example .env
Then you can run the project, I recommend to use the watch mode:
# development
$ npm run start
# watch mode -- RECOMMENDED
$ npm run start:dev
# production mode
$ npm run start:prod
This project uses compodoc for the documentation. On the movie-use-case.ts file there is an example of the documentation comments.
Execute
npx @compodoc/compodoc -p tsconfig.json -s
Then you can open your browser and navigate to the documentation
You can run the project and then you can open your browser and navigate [to /docs to see the swagger documentation](the documentation)
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
- Author - Juan Sebastian Cifuentes