... | ... | @@ -44,22 +44,20 @@ TBD |
|
|
|
|
|
<h3 id="back-end-def-tec">Definições de Tecnologias</h3>
|
|
|
|
|
|
- **Spring Boot:** é uma ferramenta que nasceu a partir do Spring, um framework desenvolvido para a plataforma Java baseado nos padrões de projetos, inversão de controle e injeção de dependência.
|
|
|
- **Postgres:** é um sistema gerenciador de banco de dados objeto relacional, desenvolvido como projeto de código aberto.
|
|
|
- **Maven:** é uma ferramenta de automação de compilação utilizada primariamente em projetos Java.
|
|
|
TBD
|
|
|
|
|
|
<h3 id="back-end-mods-sis">Módulos do Sistema</h3>
|
|
|
|
|
|
* **config:** contém as configurações de cors e do Swagger.
|
|
|
* **controller:** é o ponto de entrada do backend, onde ficam os endpoints da aplicação.
|
|
|
* **entity:** camada que contém entidades que se espelham ao banco de dados.
|
|
|
* **dto:** possui os objetos utilizados para o transporte de dados entre as camadas.
|
|
|
* **enums:** possui as enumerações que são usados nos dtos ou nas entidades.
|
|
|
* **message:** Possui todas as mensagens que são devolvidas para o frontend, para a visualização do usuário.
|
|
|
* **repository:** é responsável por fazer toda comunicação com o banco de dados.
|
|
|
* **security:** define configurações de acesso aos endpoints e controla o login e autenticação de usuários cadastrados.
|
|
|
* **service:** camada que contém as regras de negócio.
|
|
|
* **util:** possui classes que contém métodos que são utilizados em diversas serviços, como o Validations.java, que contém validações de campos de um objeto. Nessa camada também ficam as exceptions personalizadas e os handlers dessas exceptions.
|
|
|
* **config**: contém as configurações de cors e do Swagger.
|
|
|
* **controller**: é o ponto de entrada do backend, onde ficam os endpoints da aplicação.
|
|
|
* **entity**: camada que contém entidades que se espelham ao banco de dados.
|
|
|
* **dto**: possui os objetos utilizados para o transporte de dados entre as camadas.
|
|
|
* **enums**: possui as enumerações que são usados nos dtos ou nas entidades.
|
|
|
* **message**: Possui todas as mensagens que são devolvidas para o frontend, para a visualização do usuário.
|
|
|
* **repository**: é responsável por fazer toda comunicação com o banco de dados.
|
|
|
* **security**: define configurações de acesso aos endpoints e controla o login e autenticação de usuários cadastrados.
|
|
|
* **service**: camada que contém as regras de negócio.
|
|
|
* **util**: possui classes que contém métodos que são utilizados em diversas serviços, como o Validations.java, que contém validações de campos de um objeto. Nessa camada também ficam as exceptions personalizadas e os handlers dessas exceptions.
|
|
|
|
|
|
### Diagrama de Fluxo
|
|
|
|
... | ... | @@ -69,13 +67,20 @@ TBD |
|
|
|
|
|
<h3 id="front-end-def-tec">Definições de Tecnologias</h3>
|
|
|
|
|
|
- **React JavaScript:** biblioteca de JavaScript, utilizada para definir a parte lógica, e criar componentes HTML, para aplicações web de página única.
|
|
|
- **Material UI:** biblioteca de componentes para interfaces gráficas de usuário de aplicações web.
|
|
|
- **CSS:** linguagem de marcação de texto, utilizada para estilizar componentes HTML.
|
|
|
- **React JavaScript**: biblioteca de JavaScript, utilizada para definir a parte lógica, e criar componentes HTML, para aplicações web de página única.
|
|
|
- **Material UI**: biblioteca de componentes para interfaces gráficas de usuário de aplicações web.
|
|
|
- **CSS**: linguagem de marcação de texto, utilizada para estilizar componentes HTML.
|
|
|
- **npm**: gerenciador de pacotes de módulos JavaScript, utilizado para instalar funcionalidades em aplicações web.
|
|
|
|
|
|
<h3 id="front-end-mods-sis">Módulos do Sistema</h3>
|
|
|
|
|
|
TBD
|
|
|
- **assets**: guarda informações importantes a nível global, como cores, imagens, e o endereço do servidor do banco de dados na internet.
|
|
|
- **components**: guarda componentes de interface gráfica, como botões e menus, para possibilitar reuso em toda a aplicação.
|
|
|
- **contexts**: guarda os scripts utilizados para reter informações que precisarão ser reutilizadas ao longo da sessão de utilização da aplicação.
|
|
|
- **enums**: guarda listas de itens importantes a nível global: rotas, códigos de HTTP, e chaves de armazenamento local.
|
|
|
- **screens**: guarda as telas, e seus respectivos modais, utilizadas para a GUI da aplicação
|
|
|
- **services**: guarda os scripts utilizados para transferir informações entre o banco de dados e o front-end.
|
|
|
- **utility**: guarda scripts utilizados para operações que não sejam específicas a páginas específicas: conversor de notação monetária, e o assistente ao serviço do Axios.
|
|
|
|
|
|
### Diagramas de Componentes
|
|
|
|
... | ... | |