🚀 CRUD NestJS

Tecnologias | Projeto | Como rodar | Licença

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

NestJS: framework utilizado para criação da aplicação.
Postgres: banco SQL utilizado para armazenar os dados.
Docker e Docker-compose: utilizado para criar e rodar o container do banco de dados.
Jest: utilizado para escrever os testes da aplicação.
GitFlow: utilizado no fluxo de desenvolvimento.
Swagger: utilizado para documentar a aplicação.

💻 Projeto

Esse projeto é um simple CRUD de produtos desenvolvido com o intuito de estudar o framework NestJS. Porém aplicando alguns conceitos mais avançados como: TDD, GitFlow, Docker, etc.

⚡ Como rodar

Requisitos

Node.js.
NestJS CLI.
Yarn ou se preferir, pode usar o npm (já vem com o node).
Docker e Docker-compose (opcional).

Subir o banco

crie uma cópia do .env.example como .env e defina suas variáveis do banco.
suba o banco de dados com docker: docker-compose up -d.

(se você não estiver usando o docker, é necessário criar o banco manualmente).

rode as migrations: yarn typeorm migration:run.

Rodar a aplicação

para rodar a aplicação: yarn start.
para rodar a aplicação em modo watch: yarn start:dev.
a aplicação estará disponível no endereço: http://localhost:3000.
a documentação estará disponível no endereço: http://localhost:3000/api.

Rodar os testes

para rodar os testes unitários: yarn test.
para ver a cobertura dos testes unitários: yarn test:cov.
para rodar os testes e2e: yarn test:e2e

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Feito com ♥ by Danilo Gonçalves. Me adicione no LinkedIn 👋

goncadanilo/simple-crud-nestjs