0x384c0 / Experiments-flutter

Example of flutter app with clean architecture

Modular Flutter App

A sample flutter app that has mutliple features.

Build Requirements

• flutter 3.+
• Android Studio

Modules

App has multiple features - posts, weather. Each feature split in to 3 modules

• Presentation - contains Presentation Layer (widgets and cubits)
• Domain - contains Domain layer with business logic (interactors and interfaces)
• Data - contains Data layer with REST API requests

Layers Scheme

Communication between layers

1. UI sends signals to Cubit
2. Cubit executes Use cases from Interactor.
3. Use case obtains data from Repository
4. Repository returns data from a Api.
5. Information flows back to the UI to be displayed.

Presentation and Data depends on Domain, but Domain know nothing about them.

Dependencies

1. rxdart
2. flutter_modular
3. flutter_cubit
4. retrofit
5. json_annotation
6. mocktail

Test coverage

• data
• domain
• widgets
• UI tests

.run scripts

• build_runner - generate code for JSON Serializable
• clean_all - run flutter clean in all modules
• pub_get_all - run flutter pub get in all modules
• generate_translate_file - regenerate localized strings
• main.dart - run app

Adding New module

• run flutter create in feature directory with unique project name. For example: flutter create --template=package --project-name features_weather_presentation presentation
• remove unused files. For example: cd presentation && rm -rf android ios linux macos windows LICENSE CHANGELOG.md
• replace homepage: with publish_to: none in podspec.yaml
• add dependencies from other modules
• add this module as dependency to other modules using path:

TODO

• replace flutter_modular with something usable
• cfug/dio#1653
• move code to src directory and use export show for exposing package apis
• add paging
• on error dismiss previous errors and add option to refresh after error
• add loading indicators using Lottie
• split localized string per module
• https://pub.dev/packages/mapify_generator
• https://pub.dev/packages/easy_localization
• https://pub.dev/packages/auto_route
• https://pub.dev/packages/freezed
• create simple module as template
• fature module should not depend on eachother, all communication via small interfaces in common module
• replace helper methods with widgets