This project was bootstrapped with Nest framework TypeScript.
Note: .env
should be secret, but I'll push it anyway only to facilitate the revision.
It doesn't imply a security problem, because GITHUB_TOKEN_API was created with only read permission.
If you want to use this project as a base, note that you have to add it to the .gitignore
file.
In the In the project directory, you can run:
$ npm install
Install all the dependencies needed to run and test the project.
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
If you want to see the project documentation you can do it in localhost:8080/docs
This documentation of API's was made using Swagger.
Go to Take-Home-Test-Fulltimeforce-Frontend and run the project to allow connect with the frontend.