|
| [Home](home) | [**Escopo**](escopo) | [Processo](processo) | [Design/Mockups](design_mockups) | [Configuração](configuracao) | [Arquitetura](arquitetura) | [Gerência](gerencia) | [Código](codigo) | [BD](Banco de Dados) | [Qualidade](qualidade) | [Frontend](frontend) | [Backend](backend) |
|
|
<table>
|
|
| :----------: | :-------------------------------: | :------------------: | :--------------: | :--------------------------: | :--------------------: | :------------------------: | :--------------: | :---------------: | :--------------------: | :---------------: | :--------------------: |
|
|
<tr>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Home](home)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[**Escopo**](escopo)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Processo](processo)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Design/Mockups](design_mockups)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Configuração](configuracao)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Arquitetura](arquitetura)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Gerência](gerencia)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Código](codigo)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[BD](Banco%20de%20Dados)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Qualidade](qualidade)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Frontend](frontend)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Backend](backend)
|
|
|
|
</th>
|
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
# Código
|
|
# Código
|
|
|
|
|
|
Esta seção contém as convenções do código desenvolvido, padrões, documentação e conceitos básicos.
|
|
Esta seção contém as convenções do código desenvolvido, padrões, documentação e conceitos básicos.
|
|
|
|
|
|
## Sumário
|
|
## Sumário
|
|
- [Repositórios](#repositórios)
|
|
|
|
|
|
- [Repositórios](#reposit%C3%B3rios)
|
|
- [Estrutura de pastas](#estrutura-de-pastas)
|
|
- [Estrutura de pastas](#estrutura-de-pastas)
|
|
- [Padrões de Código](#padrões-de-código)
|
|
- [Padrões de Código](#padr%C3%B5es-de-c%C3%B3digo)
|
|
|
|
|
|
## Repositórios
|
|
## Repositórios
|
|
|
|
|
|
### Backend
|
|
### Backend
|
|
|
|
|
|
Link para o repositório: [Globo Aplausos Backend](https://tools.ages.pucrs.br/globo-aplausos/globo-aplausos-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.
|
|
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.
|
... | @@ -25,7 +79,8 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
... | @@ -25,7 +79,8 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
|
|
|
|
|
### Backend
|
|
### Backend
|
|
|
|
|
|
📁 raiz do projeto
|
|
:file_folder: raiz do projeto
|
|
|
|
|
|
- prisma
|
|
- prisma
|
|
- Pasta utilizada para armazenar as informações e arquivos relacionados ao Prisma, como as seeds e migrations.
|
|
- Pasta utilizada para armazenar as informações e arquivos relacionados ao Prisma, como as seeds e migrations.
|
|
- src
|
|
- src
|
... | @@ -48,7 +103,9 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
... | @@ -48,7 +103,9 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
|
- Pasta utilizada para armazenar os testes unitários da aplicação.
|
|
- Pasta utilizada para armazenar os testes unitários da aplicação.
|
|
|
|
|
|
### Frontend
|
|
### Frontend
|
|
📁 raiz do projeto
|
|
|
|
|
|
:file_folder: raiz do projeto
|
|
|
|
|
|
- public
|
|
- public
|
|
- Pasta para recursos públicos acessíveis diretamente.
|
|
- Pasta para recursos públicos acessíveis diretamente.
|
|
- src
|
|
- src
|
... | @@ -57,8 +114,9 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
... | @@ -57,8 +114,9 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
|
- components
|
|
- components
|
|
- Pasta para componentes reutilizáveis da interface.
|
|
- Pasta para componentes reutilizáveis da interface.
|
|
- pages
|
|
- pages
|
|
- api
|
|
- Pasta para páginas da aplicação. (ex. Home, Login)
|
|
- Pasta para os serviços de integração com API's.
|
|
* api
|
|
|
|
* Subpasta para os serviços de integração com API's.
|
|
- styles
|
|
- styles
|
|
- componentes
|
|
- componentes
|
|
- Pasta para estilos dos componentes.
|
|
- Pasta para estilos dos componentes.
|
... | @@ -67,15 +125,14 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
... | @@ -67,15 +125,14 @@ Parte visual da aplicação, que será utilizada pelos colaboradores da Globo. |
|
- utils
|
|
- utils
|
|
- Pasta para funções utilitárias e lógica compartilhada.
|
|
- Pasta para funções utilitárias e lógica compartilhada.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Padrões de código
|
|
## Padrões de código
|
|
|
|
|
|
Neste seção serão apresentadas as convenções de código que serão utilizadas no projeto.
|
|
Neste seção serão apresentadas as convenções de código que serão utilizadas no projeto.
|
|
|
|
|
|
### Padrões Gerais
|
|
### Padrões Gerais
|
|
|
|
|
|
- Os nomes de arquivos, classes, componentes, variáveis e estilos deve ser em `inglês`.
|
|
- Os nomes de arquivos, classes, componentes, variáveis e estilos deve ser em `inglês`.
|
|
|
|
|
|
[**Frontend**](Frontend)
|
|
[**Frontend**](Frontend)
|
|
|
|
|
|
[**Backend**](Backend) |
|
[**Backend**](Backend) |
|
|
|
\ No newline at end of file |
|
|
|
|