Este template possui comandos automatizados para gerar componentes para a construção do backend. Os comandos podem ser executados com:
yarn
npm
Antes de tudo instale as dependências
$ yarn
Utilizando a cli com yarn
$ yarn types-ddd
Utilizando a cli com npm
$ npm run types-ddd
Para instalar e gerenciar novos pacotes (libs) utilize yarn.
Dependência de produção
$ yarn add <package-name>
Dependência de desenvolvimento
$ yarn add <package-name> -D
Este template já possui um alias global @modules
e @shared
configurado
@modules/*
aponta para o caminhosrc/modules/*
@shared/*
aponta para o caminhosrc/shared/*
Para adicionar novos alias siga o modelo nos arquivos:
tsconfig.json
jest-e2e.json
jest.config.json
A inclusão deve ser feita em todos esses 3 arquivos.
Testes.
Executar testes unitários.
obs: Os teste unitários devem ter o padrão de nome <file-name>.spec.ts
$ yarn test
Executar testes de integração.
obs: Os teste de integração devem ter o padrão de nome <file-name>.test.ts
$ yarn test:e2e
Executar a aplicação em watch mode
$ yarn start:dev
Executar a aplicação
$ yarn start
Para verificar se a aplicação está ok
GET http://localhost:3000/healthCheck
Este template já está configurado com swagger
Após iniciar a aplicação basta acessar o endpoint
GET http://localhost:3000/docs
As variáveis de ambiente devem ser definidas no arquivo
src/shared/env.ts
Após definir as variáveis no env.ts você pode definí-las no arquivo .env
Os commits devem seguir a convenção do commit lint
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
feat
: nova featurebuild
: mudanças que afetam o processo de buildchore
: instalação de lib, ou configuração de ferramentasci
: configuração de script ou processos do pipelinedocs
: atualização de documentaçãostyle
: mudanças que afetam o estilo do código, formatação etcrefactor
: alteração ou melhoria de código que não seja bug ou featureperf
: melhorias de código que melhoram a performancetest
: adicionado testes ou correção de algum
Exemplo:
$ git commit -m "test (payment): ensure payment confirmation"