|
|
Frontend section |
|
| [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) | [Analytics](analytics) |
|
|
\ No newline at end of file |
|
| :----------: | :------------------: | :------------------: | :------------------------------: | :--------------------------: | :------------------------: | :------------------: | :--------------: | :------------------: | :--------------------: | :------------------: | :----------------: | ---------------------: |
|
|
|
|
|
|
|
|
# Frontend
|
|
|
|
|
|
|
|
Esta página centraliza informações sobre o [repositório Frontend do projeto Sem Barreiras](https://tools.ages.pucrs.br/sem-barreiras/sembarreiras-frontend).
|
|
|
|
|
|
|
|
## Sumário
|
|
|
|
|
|
|
|
- [Organização do repositório](#organização-do-repositório)
|
|
|
|
- [Padrões de código](#padrões-de-código)
|
|
|
|
- [Nomenclatura de funções](#nomenclatura-de-classes)
|
|
|
|
- [Nomenclatura de variáveis](#nomenclatura-de-variáveis)
|
|
|
|
- [Nomenclatura de componentes](#nomenclatura-de-componentes)
|
|
|
|
- [Nomenclatura de telas](#nomenclatura-de-telas)
|
|
|
|
- [Documentação de componentes e telas](#documentação-de-componentes-e-telas)
|
|
|
|
|
|
|
|
## Organização do repositório
|
|
|
|
|
|
|
|
WIP
|
|
|
|
|
|
|
|
Diante disso, os pacotes do projeto estão divididos da forma abaixo:
|
|
|
|
|
|
|
|
- :file_folder: `src/`
|
|
|
|
- :file_folder: `apis/`: Chamadas de api aos endpoints do Backend.
|
|
|
|
- :file_folder: `api.js`: Arquivo com o cliente do axios que reliza as chamadas.
|
|
|
|
- :file_folder: `assets/`: Recursos como imagens e ícones.
|
|
|
|
- :file_folder: `dummy.png`: Imagem a ser utilizada em algum lugar.
|
|
|
|
- :file_folder: `components/`: Componentes reutilizáveis.
|
|
|
|
- :file_folder: `Component.js`: Implementação de código de um componente.
|
|
|
|
- :file_folder: `constants/`: Variáveis constantes.
|
|
|
|
- :file_folder: `colors`: Cores constantes da aplicação.
|
|
|
|
- :file_folder: `connection`: Constantes para conexão com o Backend.
|
|
|
|
- :file_folder: `routes/`: Roteamento das telas.
|
|
|
|
- :file_folder: `router.js`: Implementação de código das rotas.
|
|
|
|
- :file_folder: `screens/`: Telas da aplicação.
|
|
|
|
- :file_folder: `Screen.js`: Implementação de código de uma tela.
|
|
|
|
- `App.js`: Chama o roteamento de telas ao iniciar o app.
|
|
|
|
|
|
|
|
## Padrões de código
|
|
|
|
|
|
|
|
TBD
|
|
|
|
|
|
|
|
### Nomenclatura de funções
|
|
|
|
|
|
|
|
### Nomenclatura de variáveis
|
|
|
|
|
|
|
|
### Nomenclatura de componentes
|
|
|
|
|
|
|
|
### Nomenclatura de telas
|
|
|
|
|
|
|
|
### Documentação de componentes e telas |
