api-literama

api-pel

Micro serviços para plataforma PEL

Wiki

Informações e guides de desenvolvimento

Rodando local

Para iniciar a API em modo de desenvolvimento:

1. Instale as dependências

npm install

1. Inicie o MongoDB

docker-compose up -d

1. Inicie a API

npm dev

Testes

Verificar os testes:

npm test

ou para que fiquem rodando a cada atualização de código

npm test:watch

Verificar testes com coverages:

npm test:coverages

Dica: Executar testes para um arquivo só enquanto desenvolve:

npx jest --watch <caminho-do-arquivo>

Exemplo:

npx jest --watch src/handlers/users/getUser.test.ts

Você pode copiar o caminho do arquivo clicando com o botão direto em cima dele utilizando a opção "Copy Relative Path"

Release

O CI/CD desse projeto atualiza o ambiente de staging assim que um código é mergeado na branch main.

O projeto apenas é atualizado em produção quando uma nova release é gerada, as releases são controladas com base em tags seguindo o versionamento semantico.

Para gerar uma nova versão siga as instruções:

npm release
git push --follow-tags

Com esses comandos uma nova tag será criada, a versão no package.json será atualizada, o changelog sera atualizado automaticamente e uma nova release será criada no gitlab.