Franccesco1907 / Take-Home-Test-Fulltimeforce-Backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Github History Commits - Backend

Description

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.

Installation

In the In the project directory, you can run:

$ npm install

Install all the dependencies needed to run and test the project.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Documentation

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.

Connect with frontend

Go to Take-Home-Test-Fulltimeforce-Frontend and run the project to allow connect with the frontend.

About


Languages

Language:TypeScript 99.3%Language:JavaScript 0.5%Language:Shell 0.2%