samirelhassann/fiap-tech-challenge-04-status-service

FIAP SOAT - Grupo 65 - Tech Challenge #04 - Status Service

Repositório do Tech Challenge #04 da FIAP/Alura, no curso SOAT3.

Este projeto é uma evolução do projeto do Tech Challenge #03. Nele é tratado o microserviço de Status.

Como rodar a aplicação?

Pré-requisitos:

• Node.js >= 18.x
• Yarn - versão usada localmente: 1.22.21
• Docker - versão usada localmente: 4.27.2

Após se certificado dos pré requisitos, siga o seguinte passo a passo:

1. Rode o docker compose para subir o banco de dados postgres

docker-compose up -d

2. Instale as dependências do projeto

yarn install

3. Atualize o prisma e subida das tabelas no banco de dados via migration

yarn prisma generate && yarn prisma migrate dev

4. duplique o arquivo .env.example e renomeie para .env. Nesse arquivo já está configurado as variáveis para rodar localmente

5. Inicialize a aplicação

yarn dev

A aplicação estará disponível, por padrão, na rota http://localhost:3004.

Como testar a aplicação?

Rode o seguinte comando para rodar os testes unitários da aplicação: yarn test

Antes de rodar os testes de bdd, cetifique-se que o banco de dados está rodando via docker-compose: docker-compose up -d.Em seguida, rode o seguinte comando para rodar os testes de BDD (e2e) da aplicação: yarn test:bdd

Documentação

Ao rodar o projeto é possível acessar com o endpoint /docs a documentação completa no Redoc ou em /docs-swagger para a visualização do Swagger padrão.

• swagger: http://localhost:3004/docs-swagger
• redoc: http://localhost:3004/docs

Membros

• Samir El Hassan