Inspirado no último desafio da trilha Node do curso da Rocketseat, é uma API que gerencia uma transportadora fictícia. Fiz alguns incrementos para deixar mais funcional na parte voltada para os entregadores e criei uma versão admin voltada para o gerenciamento da transportadora.
O entregador consegue criar um cadastro, fazer o login, se autenticar, retirar entregas disponíveis de acordo com a sua localização e efetivar a entrega coletada mediante ao envio do pacote entregue.
Já o administrador consegue criar um registro para destinatários, criar pedidos e acessar um painel (dashboard) que gerar os resultados diários das coletas/entregas.
- NodeJS
- PostgreSQL
- Docker
- Vitest (testes automatizados)
- Domain-Driven Design (DDD), Domain Events, Clean Architecture e Solid;
- Autenticação e Autorização (RBAC);
- Testes unitários e e2e;
- Integração com serviços externos (R2 Storage e Gmail via Nodemailer)
- NodeJS
- NPM
- Docker
- Faça o clone do repositório e no terminal navegue até a pasta
- Instale as dependências do projeto com
npm install - Faça uma conta gratuita no serviço externo R2 Storage na Cloudflare
- Preencha as variáveis de ambiente no arquivo
.env - Faça o set up do Prisma com
npx prisma init - Rode o docker compose com
docker compose up -d - Rode o servidor de desenvolvimento com
npm run start:dev
A API está documentada através do Swagger através da rota:
Pull requests são bem-vindos. Para maiores alterações, favor abrir uma issue primeiro para argumentar o que gostaria de implementar no projeto.
Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.