PADRÕES E BOAS PRÁTICAS - FLUTTER

Introdução

O objetivo é que este documento seja usado como guia para o desenvolvimento de projetos, estabelecendo de forma comum a todo time as práticas, metodologias, arquiteturas, padrões, frameworks etc. que podem/devem ser usados.

Este ponto é importante, pois uma vez que estabelecido um "Protocolo" entre todo o time, pontos como controle de qualidade, alinhamento técnico do time, manutenibilidade, etc.

Outro aspecto importante, o conteúdo deste guia não será estático, ou seja, podendo ser alterado a medida que novas tecnologias e necessidades surgirem, por isso o time está sempre aberto a escutar propostas e melhorias que possam ser agregadas a este documento.

Para tal basta editar este documento e submeter um pull request com alteração ou abrir uma issue neste repositório.

Versão flutter

A Versão do flutter que é utilizada neste projeto foi a 3.0.5

Proposta estrutural

Seguindo o conceito de monorepo, ou seja, cada projeto ficara em um repositorio diferente, assim facilitando a manutenção por modulos separados, o conceito de Micro Apps.

O projeto está organizado na seguinte estrutura:

• base_app: Responsável por rodar a aplicação. Único que conhece todos os Micro Apps da aplicação.

• dependencies: Mantém centralizadas todas as dependências dos Micro Apps.

• micro_app: Devem ser seguidas algumas regras desse tipo de package:

  1. Um Micro App nunca deve referenciar outro Micro App (Se a lógica for compartilhada, deve ser criado um micro_commons)
  2. Seguir em todos os Micro Apps a mesma arquitetura e estrutura de pastas, inclusive nos testes
  3. Não adicionar dependências externas nesses packages (Sempre adicionar no package dependencies)

• micro_commons:

  1. Um Micro Commons pode referenciar outro Micro Commons, porem sempre tentando evitar o acoplamento ao maximo para cada micro commons ter facil reuso em novos projetos.
  2. Seguir em todos os Micro Apps a mesma arquitetura e estrutura de pastas, inclusive nos testes
  3. Não adicionar dependências externas nesses packages (Sempre adicionar no package dependencies)

• MONOREPO

Apresentação geral da arquitetura

A arquitetura do projeto é dividia de forma modular subdividido em micro apps, onde tem o menor índice de acoplamento possível.

Cada módulo contem seu próprio ecossistema de arquitetura e a proposta adotada foi a do clean dart. Veja a documentação sobre CLEAN aqui

Executando o projeto

Para executar, levar em consideração os flavors dev, qa e prd.

Cada flavor possui um arquivo de configurações dentro da pasta base_app/.env_<flavor>.

Executar sempre da seguinte maneira:

cd base_app
flutter run -t lib/main_<flavor>.dart --flavor <flavor> 

Pull Requests

Veja a documentação sobre Pull Request aqui

Git Flow

Veja a documentação sobre Git Flow aqui

Testes

Veja a documentação sobre Testes aqui

Recursos de terceiros

É importante que o time esteja alinhado sobre quais recursos de terceiros (libraries, frameworks, SDK's) podem ser utilizadas nos projetos do time de flutter, uma vez que essas dependências podem ter um impacto significativo no desenvolvimento e manutenção de um projeto (depreciação, bugs em aberto, incompatibilidades etc.).

Antes de adicionar um recursos que não esteja na lista abaixo, observar os seguintes itens:

• Issues abertas Github
• Likes, Pub Points, Popularity
• Data ultima alteração
• Resolução de bugs encontrados
• Atualização para recursos mais novos do Flutter/Dart, ex. Null Safety

Boas práticas de desenvolvimento

Para garantir que as boas práticas de desenvolvimento seguindo a guia oficial do Dart utilizamos o package flutter_lints Isso ira gerar Avisos de linhas que não condiz com as boas praticas do Flutter

Dicas

Abaixo há alguns links de documentações, artigos e trilhar de estudos

• Testes
• White Label Apps
• White Label in Flutter
• Modular

Trilha recomendada de estudos:

Iniciando:

Trila de estudos disponibilizadas pelo canal Flutterando, nivel iniciante mais detalhada https://www.youtube.com/watch?v=9m3PvcQ18Hk&list=PLlBnICoI-g-cqwYgp3uBiphS4KC3daJ-R

Trila de estudos disponibilizadas pelo canal Flutterando, com uma abordagem um pouco mais rápida https://www.youtube.com/watch?v=XeUiJJN0vsE&list=PLlBnICoI-g-d-J57QIz6Tx5xtUDGQdBFB

ou curso pago na udemy nivel iniciante para médio https://www.udemy.com/course/curso-completo-flutter-app-android-ios/learn/lecture/11038094?start=15#overview

Uso do flutter_modular:

https://www.youtube.com/watch?v=cIO1im9sLb0&list=PLlBnICoI-g-cVJ2sfu65-HjDtQepbrvjS

documentação flutter modular

https://modular.flutterando.com.br/docs/flutter_modular/start/

trilha de estudos: Clean Architecture

https://www.youtube.com/watch?v=VacEeKvY2bg&list=PLlBnICoI-g-d-v_fWlkZX2HRgHHPnJx9s

trilha de estudos: Conceitos mais avançados e entendimento de monolito, monorepo e multirepo

https://www.youtube.com/watch?v=5rjQ5ooWDoY&list=PLRpTFz5_57cufduUDgiZZqA_k5Q7UV_50