Nossos Repositórios

⚠ Todo o código fonte, com exceção de documentações e textos deverá ser escrito em inglês ⚠

Backend

auth

Serviço de autenticação OAuth 2 do projeto funcionando com ⚠ a decidir entre keycloak e cognito ⚠

api

Serviço geral da aplicação com todos os endpoints de operações chamadas pelo frontend

Frontend

web

UI web para utilização por parte das instituições/colaboradores

app

UI mobile para utilização por parte do público geral

Estrutura de pastas

Backend

📂 raiz do projeto
    📂 config
        Definição de singletons usados para configurar a aplicação

    📂 domain
        Entidades, DTOs referentes ao domínio da aplicação e VOs (Objetos de Valor)

    📂 repository
        Camada de acesso aos dados usando o Spring Data JPA - acessada pelas services

    📂 service
        Camada de orquestração de entidades e lógica de negócio - acessada pelas controllers

    📂 web
    - 📂 controller
           Camada de definição dos enpoints, chamada das services e montagem dos payloads de resposta
    - 📂 representation
           Pasta para as classes de request/response
        - 📂 response
           Pasta para os payloads de resposta da aplicação
        - 📂 request
           Pasta para os payloads de requisição da aplicação
        - 📂 error
           Pasta para os payloads de erro da aplicação

Frontend (Web)

📂 raiz do projeto

    📂 public

        Pasta para recursos públicos acessíveis diretamente

    📂 src

            📂 __tests__

            Pasta para testes automatizados

            📂 app

                Pasta para arquivos inicializadores do app

            📂 assets

                Pasta para recursos estáticos como imagens, ícones, etc.

            📂 components

                Pasta para componentes reutilizáveis da aplicação

            📂 pages

                Pasta para as páginas principais ou roteirizadas da aplicação

            📂 services

                📂 apis

                    Pasta para os serviços de integração com APIs externas

                📂 dtos

                    Pasta para modelos ou estruturas de dados

            📂 theme

                📂 components

                    Pasta para componentes relacionados ao tema/design

Frontend (Mobile)

📂 raiz do projeto

    📂 src

            📂 __tests__

            Pasta para testes automatizados

            📂 app

                📂 page_name

                Pasta para as páginas (o nome "page_name" deve ser a rota /page_name)

            📂 assets

                Pasta para recursos estáticos como imagens, ícones, etc.

            📂 components

                Pasta para componentes reutilizáveis da aplicação

            📂 services

                📂 apis

                    Pasta para os serviços de integração com APIs externas

                📂 dtos

                    Pasta para modelos ou estruturas de dados

            📂 theme

                📂 components

                    Pasta para componentes relacionados ao tema/design