Clean App Model é um projeto incial usando Arquitetura Limpa com funcionalidades de registro de usuário, login e recuperação de senha baseado em Node.js, Typescript, Express, JWT, Bcrypt, Jest, Supertest, Prisma, Mysql, ESLint, Prettier, Husky, Commitizen e Lint-staged.
- ✔️ Registro de usário
- 🔧 Login
- Recuperação de senha
- Node.js
- npm
- Docker (opcional)
- Execute o seguinte comando em seu ambiente local:
git clone /~https://github.com/HitaloNasc/clean-app-model-backend.git
cd clean-app-model-backend
npm install
- Em seguida, você deve subir o banco de dados de desenvolvimento (requer docker):
npm run db:dev:up
- Alimente o banco de desenvolvimento com as migrations
npm run db:dev:push
- Execute o projeto localmente no modo desenvolvimento:
npm run start:dev
Por padrão o projeto rodará na porta 3333, mas isto pode ser alterado nas variáveis de ambiente para desenvolvimento em /.env.development.
- Você deve subir o banco de dados de teste (requer docker):
npm run db:test:up
- Alimente o banco de teste com as migrations
npm run db:test:push
- Execute o script de teste:
npm run test
Todos os comandos são executados a partir da raiz do projeto, a partir de um terminal:
| Command | Action |
|---|---|
npm install |
Instala as dependências do projeto |
npm run start:dev |
Inicial o projeto localmente na porta localhost:3333 |
npm run db:dev:up |
Instancia um container com um banco de dados mysql para consumo no modo desenvolvimento |
| `npm run db:dev:down | Para container com um banco de dados mysql no modo desenvolvimento |
npm run db:test:up |
Instancia um container com um banco de dados mysql para consumo no modo teste |
| `npm run db:test:down | Para container com um banco de dados mysql no modo teste |
npm run test |
Executa todos os testes |
npm run test:unit |
Executa apenas os testes unitários no modo watch |
npm run test:integration |
Executa apenas os testes de integração no modo watch |
npm run lint |
Executa o ESLint e reporta os problemas no código |
npm run format |
Executa o Prettier formata os arquivos com problema de identação |