Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • Globo Aplausos Wiki Globo Aplausos Wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Globo Aplausos
  • Globo Aplausos WikiGlobo Aplausos Wiki
  • Wiki
  • Codigo

Codigo · Changes

Page history
Update Codigo authored Aug 30, 2023 by Henrique Cardoso Zanette's avatar Henrique Cardoso Zanette
Hide whitespace changes
Inline Side-by-side
Codigo.md
View page @ 2ff0ea84
...@@ -5,13 +5,77 @@ ...@@ -5,13 +5,77 @@
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)
- [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õ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 ## 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 ## 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) |
| ------------- | ------------- |
Clone repository
  • Analytics
  • Arquitetura
  • Backend
  • Banco de Dados
  • Codigo
  • Configuracao
  • Design_Mockups
  • Escopo
  • Frontend
  • Processo
  • Qualidade
  • gerencia
  • Home