management-service

API REST/GraphQL de gerenciamento acadêmico do Ladesa, construída com NestJS, TypeORM e PostgreSQL, seguindo arquitetura hexagonal com DDD e CQRS.

Ambiente de desenvolvimento público: https://dev.ladesa.com.br/api/v1/docs/

flowchart LR
    Apresentacao["Apresentação\nREST + GraphQL"] --> Aplicacao["Aplicação\ncommand/query handlers"]
    Aplicacao --> Dominio["Domínio\nentidades, contratos"]
    Infraestrutura["Infraestrutura\nTypeORM, Keycloak, RabbitMQ"] -- "implementa contratos de" --> Dominio

Loading

A documentação completa (setup, arquitetura, contribuição, deploy) está em docs/, gerada a partir de docs/ com MkDocs + Material.

flowchart TB
    Docs[docs/] --> Aprender[Aprender: explicação]
    Docs --> Arquitetura[Arquitetura: referência]
    Docs --> Operacao[Operação: tutorial/how-to]

Loading

Começando rápido

git clone https://github.com/ladesa-ro/management-service.git
cd management-service
just up            # sobe os containers e abre um shell dentro do container
bun run dev         # dentro do container: servidor com hot reload

Todo o ambiente é containerizado, não é necessário instalar Bun, Node.js ou PostgreSQL na máquina. Passo a passo completo, variáveis de ambiente e troubleshooting em Comece por aqui.

Pra editar a documentação localmente:

docker run --rm -it -p 8000:8000 -v "$PWD":/docs squidfunk/mkdocs-material:9.7.7

Licença

MIT © desde 2024, Ladesa.