Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • appoio-wiki appoio-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
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • APPOIO
  • appoio-wikiappoio-wiki
  • Wiki
  • arquitetura

arquitetura · Changes

Page history
Update arquitetura authored Sep 24, 2020 by João Vitor Bernardi Severo's avatar João Vitor Bernardi Severo
Show whitespace changes
Inline Side-by-side
arquitetura.md
View page @ 98adaa9f
...@@ -3,7 +3,48 @@ ...@@ -3,7 +3,48 @@
# Arquitetura # Arquitetura
Esta é a página onde irá ficar todas as informações da Arquitetura do seu projeto, Como: > Nenhum dos diagramas a seguir foi validado ainda
### Diagrama de Deploy
![deployment_diagram](uploads/1665c5af7019c0cd98526ea6c4516adc/deployment_diagram.jpeg)
------
## Backend
### Estrutura geral do backend do projeto:
![estrutura geral](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Estrutura_backend.png)
------
### Diagramas de Sequencia
#### Usuário
![diagrama usuario](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Diagrama_Sequencia_Usuario.png)
------
### Padrões de código
#### Arquivos
Todos arquivos, com exceção dos "index.js", devem fazer uso do padrão PascalCase, ou seja, primeira letra de cada palavra deve ser maiúscula.
![exemplo de arquivo](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Arquivo.png)
#### Classes
As classes devem ser nomeadas no singular e fazendo uso do padrão PascalCase para nomeação, ou seja, primeira letra de cada palavra deve ser maiúscula.
![exemplo de classe](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Classe.png)
#### Funções e Variáveis
As variáveis utilizadas no programa devem fazer uso do padrão camelCase para nomeação, ou seja, primeira letra minúscula e a separação das palavras é por letra maiúscula.
![exemplo de código](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Código.png)
#### Documentação
Fazer uso de comentários com /**/ logo acima do pedaço de código que irá ser documentado, pode incluir marcações como @example, @param, @returns, idealmente devem ser incluídas todas as marcações, mas caso não seja simples/possível deve ter ao menos @param e @returns na documentação.
![exemplo documentação](https://tools.ages.pucrs.br/appoio/appoio-wiki/raw/master/images/arquitetura/Formato_Documentacao.png)
* Segurança * Segurança
* Rotas de Backend (Arquitetura * Rotas de Backend (Arquitetura
...@@ -13,15 +54,5 @@ funcional) ...@@ -13,15 +54,5 @@ funcional)
* Arquitetura Não Funcional) * Arquitetura Não Funcional)
* Diagrama de Pacotes / Componentes * Diagrama de Pacotes / Componentes
(Arquitetura de software) (Arquitetura de software)
* Diagrama de Deploy (Em debate..)
![deployment_diagram](uploads/1665c5af7019c0cd98526ea6c4516adc/deployment_diagram.jpeg)
* Documentação sobre aplicação de
Design do Projeto
* Análise dos principios SOLID * Análise dos principios SOLID
* Code Review * Code Review
*
Devem ser apresentados das seguintes formas:
* Imagens ou Gifs
* Diagramas ou Sistemas
* Descrições ou Textos explicativos
\ No newline at end of file
Clone repository
  • Rotas
  • arquitetura
  • banco_dados
  • configuracao
  • deploy
  • escopo
  • git_workflow
  • gp
  • Home
  • instalacao
  • mockups
  • padronizacao
  • processo
  • qualidade