Api Academico

Pontos principais do projeto

- as Regras de negócio ficam na camada de serviço src/services

- quando é preciso fazer algum tratamento mais especifico ou recorrente, fica na pasta helpers

- Copie o .env.example para criar o arquivo .env

- Para inicializar o projeto, é só dar um docker compose up, se for a primeira vez adicione a flag -- build (Será necessário ter o node e docker instalado na maquina )

Trilha base para começar a desenvolver/entender o projeto

- Para começar a entender o projeto, faça o fluxo descrito no diagrama, e se atente-se bastante a camada service, ela contem as regras de negócios

- O tratamento sobre os dados, em sua maioria se encontra na camada service, e o restante está na controller com o auxilio de helpers

- Se estiver difícil acompanhar/entender quais regras o serviços e o helper estão seguindo, olhe os testes unitários e veja os tratamentos específicos de cada função

Padrões do código

- como o código está usando o framework nest.js, o código é modularizado e usamos por padrão a inversão de dependência

- Recomendo usar a Cli do nest para criar os módulos/controllers/services no padrão automaticamente, se necessário criar apartir do zero o código, atente-se a colocar o nome da classe em PascalCase e as funções/variaveis ter nomenclaturas descritivas em camelCase

Diagrama por imagem ou feito pelo mermaid

⁠

⁠

⁠

endpoints ou Swagger