Frontend

Esta página centraliza informações sobre o repositório Frontend do projeto Sem Barreiras.

Sumário

• Organização do repositório
• Padrões de código
  • Nomenclatura de funções
  • Nomenclatura de variáveis
  • Nomenclatura de componentes
  • Nomenclatura de 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:

• 📁 src/
  • 📁 apis/: Chamadas de api aos endpoints do Backend.
    • 📁 api.js: Arquivo com o cliente do axios que reliza as chamadas.
  • 📁 assets/: Recursos como imagens e ícones.
    • 📁 dummy.png: Imagem a ser utilizada em algum lugar.
  • 📁 components/: Componentes reutilizáveis.
    • 📁 Component.js: Implementação de código de um componente.
  • 📁 constants/: Variáveis constantes.
    • 📁 colors: Cores constantes da aplicação.
    • 📁 connection: Constantes para conexão com o Backend.
  • 📁 routes/: Roteamento das telas.
    • 📁 router.js: Implementação de código das rotas.
  • 📁 screens/: Telas da aplicação.
    • 📁 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