| ... | ... | @@ -5,13 +5,77 @@ |
|
|
|
Esta seção contém as convenções do código desenvolvido, padrões, documentação e conceitos básicos.
|
|
|
|
|
|
|
|
## Sumário
|
|
|
|
- [Repositórios](#repositórios)
|
|
|
|
- [Estrutura de pastas](#estrutura-de-pastas)
|
|
|
|
- [Padrões de Código](#padrões-de-código)
|
|
|
|
|
|
|
|
## Repositórios
|
|
|
|
### Backend
|
|
|
|
Link para o repositório: [Globo Aplausos Backend](https://tools.ages.pucrs.br/globo-aplausos/globo-aplausos-backend)
|
|
|
|
|
|
|
|
Serviço de Backend da aplicação, no qual é configurada a conexão com o banco de dados e onde são criados os endpoints utilizados pelo Frontend.
|
|
|
|
|
|
|
|
### Frontend
|
|
|
|
|
|
|
|
Link para o repositório: [Globo Aplausos Frontend](https://tools.ages.pucrs.br/globo-aplausos/globo-aplausos-frontend)
|
|
|
|
|
|
|
|
Parte visual da aplicação, que será utilizada pelos colaboradores da Globo.
|
|
|
|
|
|
|
|
## Estrutura de pastas
|
|
|
|
|
|
|
|
### Backend
|
|
|
|
|
|
|
|
📁 raiz do projeto
|
|
|
|
- prisma
|
|
|
|
- Pasta utilizada para armazenar as informações e arquivos relacionados ao Prisma, como as seeds e migrations.
|
|
|
|
- src
|
|
|
|
- api
|
|
|
|
- Pasta principal que armazena os itens da API, aqui temos os arquivos de módulo que irão disponibilizar os módulos criados pela API e também o arquivo `main.ts` que é responsável por inicializar a aplicação.
|
|
|
|
- módulo
|
|
|
|
- dto
|
|
|
|
- Pasta que contém objetos de transferência de dados relacionados ao módulo.
|
|
|
|
- model
|
|
|
|
- Pasta que contém os modelos de dados relacionados ao módulo.
|
|
|
|
- controller.ts
|
|
|
|
- Arquivo responsável por controlar as ações e lógica relacionadas ao módulo.
|
|
|
|
- module.ts
|
|
|
|
- Arquivo que define o módulo da API e suas configurações.
|
|
|
|
- service.ts
|
|
|
|
- Arquivo que contém a lógica de negócios e operações do módulo.
|
|
|
|
- database
|
|
|
|
- Pasta que contém as informações relacionadas à conexão do serviço com o Prisma.
|
|
|
|
- test
|
|
|
|
- Pasta utilizada para armazenar os testes unitários da aplicação.
|
|
|
|
|
|
|
|
### Frontend
|
|
|
|
📁 raiz do projeto
|
|
|
|
- public
|
|
|
|
- Pasta para recursos públicos acessíveis diretamente.
|
|
|
|
- src
|
|
|
|
- assets
|
|
|
|
- Pasta para armazenar recursos como imagens e ícones SVG.
|
|
|
|
- components
|
|
|
|
- Pasta para componentes reutilizáveis da interface.
|
|
|
|
- pages
|
|
|
|
- api
|
|
|
|
- Pasta para os serviços de integração com API's.
|
|
|
|
- styles
|
|
|
|
- componentes
|
|
|
|
- Pasta para estilos dos componentes.
|
|
|
|
- pages
|
|
|
|
- Pasta para estilos das páginas.
|
|
|
|
- utils
|
|
|
|
- Pasta para funções utilitárias e lógica compartilhada.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Padrões de código
|
|
|
|
Neste seção serão apresentadas as convenções de código que serão utilizadas no projeto.
|
|
|
|
|
|
|
|
### Padrões Gerais
|
|
|
|
- Os nomes de arquivos, classes, componentes, variáveis e estilos deve ser em `inglês`.
|
|
|
|
|
|
|
|
[**Frontend**](Frontend)
|
|
|
|
|
|
|
|
[**Backend**](Backend)
|
|
|
|
|
|
|
|
| [**Frontend**](Frontend) | [**Backend**](Backend) |
|
|
|
|
| ------------- | ------------- | |
