Jessica Da Silva ManoelCódigo
Descrição
Aqui serão apresentadas as convenções do código desenvolvido. padrões, documentação e conceitos básicos serão alguns dos assuntos abordados.
Sumário
Nomenclatura de Arquivos
A convenção utilizada no projeto para nomenclatura de arquivos do Front-End é o padrão 'Snake case', onde o nome de cada arquivo inicia com letra minúscula e cada espaço é substituído por um caractere underscore (_). Exemplos deste tipo de nomenclatura podem ser vistos nas imagens abaixo nos próximos tópicos.
Components
Classes reutilizáveis que tem as seguintes funcionalidades:
- Estrutura e navegação do aplicativo.
- Botões.
- Input e seleções.
- Diálogos, alertas e painéis.
- Display de informações.
- Layout.
Pages
- Classes que servem principalmente para estruturar as páginas principais do aplicativo.
Services
- Classes em Dart especializadas para comunicar com o back-end
Stores
- Classes para gerenciar os estado do aplicativo
Estrutura de código
As Pages utilizam os components reutilizáveis, comunica a interação do usuário através das stores que por sua vez enviam as informações, utilizando os services disponíveis, para o banco de dados (Firebase). E o processo contrário ocorre para exibir as informações armazenadas no banco.