- Express
- Jest
- Typescript
- Node
- Dynamoose
- Joi
- Husky
- Lint Staged
src
|-- @types
|-- config
|-- models
|-- modules
|-- shared
|-- server.ts
|-- index.ts
Requisitos para rodar o projeto nodeJS >= 14. Clonar repositório, entrar na pasta e instalar suas dependências com o comando yarn
ou npm install
e copiar o arquivo .env.example
para .env
configurando as variáveis de acordo com o ambiente.
Rodar na pasta raiz do projeto o comando docker-compose up
.
Obs: Para entrar na documentação da api, após iniciar o servidor acessar a rota
/docs
.
Testes
Rodar testes
npm test
Rodar cobertura de testes
npm run test:ci
Rodar testes verbosos
npm run test:verbose
Rodar testes unitários
npm run test:unit
Rodar testes de integração (Obs: não tive tempo para desenvolver testes de integração)
npm run test:integration
Rodar testes de arquigos staged
npm run test:staged
Rodar código
Servidor de desenvolvimento
npm run dev
Servidor de produção
*** Antes rodar script de build ***
npm run start
Buildar código
npm run build