readme.md

Kanban API

Api para um sistema de kanban simples

Tecnologias utilizadas

• Typescript
• NodeJS
• Express
• Prisma
• Postgres
• Vitest

Features da aplicação

• Rotas CRUD de usuários
• Rotas CRUD de tasks
• Arquitetura MVC com princípios de SOLID e Clean Architecture
• Sistema de autenticação JWT
• Testes unitários não dependentes de banco de dados
• Testes end-to-end
• Sistema de gerenciamento de erros

Como rodar a aplicação

1. Clone o repositório git clone https://github.com/JoaoManoelFontes/Project-kanban-api
2. Instale as dependências npm install ou yarn install
3. Crie um arquivo .env na raiz do projeto e o preencha com as variáveis de ambiente que estão no arquivo .env.example, substituindo os valores das variáveis de ambiente pelos valores desejados
   • Caso não tenha um banco de dados postgres, execute o comando npx run docker:init-db ou yarn docker:init-db para criar um container docker com o banco de dados postgres (é necessário ter o docker instalado)
4. Rode as migrations npx prisma migrate dev ou yarn prisma migrate dev
5. Rode a aplicação npm run dev ou yarn dev
6. Acesse a aplicação em http://localhost:3333

Testando a aplicação

1. Rode os testes unitários npm run test:unit ou yarn test:unit
2. Rode os testes end-to-end (funcionalidade não finalizada)
   • Execute o comando npm run pretest:e2e ou yarn pretest:e2e para iniciar o servidor de testes
   • Execute o comando npm run test:e2e ou yarn test:e2e para rodar os testes end-to-end
3. Rode os testes de cobertura para testes unitários npm run test:unit:coverage ou yarn test:unit:coverage
4. Teste a aplicação com o REST Client
   • Para testar a aplicação com o REST Client, instale a extensão REST Client no VSCode e execute os requests da pasta client
   • Os testes também podem ser feitos com o Insomnia, Postman ou outro software de sua preferência