Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamesbrel/flutter_clean_and_modular_arch_with_flutter_bloc
Clean, modular architecture is a particularly interesting concept... for a project that is structured, maintainable and scalable without a hitch...
https://github.com/jamesbrel/flutter_clean_and_modular_arch_with_flutter_bloc
bloc clean-architecture dart flutter flutter-bloc mobile modularization
Last synced: about 2 months ago
JSON representation
Clean, modular architecture is a particularly interesting concept... for a project that is structured, maintainable and scalable without a hitch...
- Host: GitHub
- URL: https://github.com/jamesbrel/flutter_clean_and_modular_arch_with_flutter_bloc
- Owner: JamesBrel
- License: mit
- Created: 2024-02-03T01:47:17.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-16T10:31:14.000Z (6 months ago)
- Last Synced: 2024-07-16T13:08:29.624Z (6 months ago)
- Topics: bloc, clean-architecture, dart, flutter, flutter-bloc, mobile, modularization
- Language: Dart
- Homepage:
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Flutter Mobile : Clean and Modular Architecture
### Author : James Brel
### Alias : The Coder
### Contact : [email protected]
---
---
## Architecture
the architecture of each feature is based on the clean architecture of Uncle Bob which is constituted mainly of 3 layers :
- Data
- Domain
- States Holder
```
📦features
┗ 📂fetch_hello_world
┃ ┣ 📂states_holder
┃ ┣ 📂data
┃ ┗ 📂domain
```
## General Folder Structure Tree
```
📦project
┣ 📂.env
┃ ┣ 📜dev.json
┃ ┣ 📜prod.json
┃ ┗ 📜staging.json
┣ 📂.vscode
┃ ┗ 📜launch.json
┣ 📂android
┃ ┣ 📂app
┃ ┃ ┣ 📂src
┃ ┃ ┃ ┗ 📜AndroidManifest.xml
┃ ┃ ┣ 📜build.gradle
┃ ┃ ┗ 📜proguard-rules.pro
┃ ┣ 📜key.properties
┃ ┗ 📜readme.md
┣ 📂assets
┃ ┣ 📂fonts
┃ ┃ ┗ 📜.gitkeep
┃ ┣ 📂images
┃ ┃ ┣ 📂jpg
┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┣ 📂png
┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┗ 📂svg
┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┣ 📂languages
┃ ┃ ┣ 📜en.json
┃ ┃ ┗ 📜fr.json
┃ ┗ 📜readme.md
┣ 📂integration_test
┃ ┗ 📂views
┃ ┃ ┣ 📂screens
┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┗ 📂widgets
┃ ┃ ┃ ┗ 📜.gitkeep
┣ 📂lib
┃ ┣ 📂src
┃ ┃ ┣ 📂core
┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┣ 📂assets_config
┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┣ 📂injectors_config
┃ ┃ ┃ ┃ ┃ ┣ 📜injector.config.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜injector.dart
┃ ┃ ┃ ┃ ┣ 📂language_config
┃ ┃ ┃ ┃ ┃ ┣ 📜translations_delegate.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜translator.dart
┃ ┃ ┃ ┃ ┗ 📂windows_config
┃ ┃ ┃ ┃ ┃ ┗ 📜window_config.dart
┃ ┃ ┃ ┣ 📂router
┃ ┃ ┃ ┃ ┣ 📜auto_routes.dart
┃ ┃ ┃ ┃ ┗ 📜auto_routes.gr.dart
┃ ┃ ┃ ┣ 📂themes
┃ ┃ ┃ ┃ ┣ 📜dark_theme.dart
┃ ┃ ┃ ┃ ┗ 📜light_theme.dart
┃ ┃ ┃ ┗ 📜init.dart
┃ ┃ ┣ 📂modules
┃ ┃ ┃ ┗ 📂hello_world_mod
┃ ┃ ┃ ┃ ┣ 📂features
┃ ┃ ┃ ┃ ┃ ┗ 📂fetch_hello_world
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂data
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂local_source
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂absts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜say_the_hello_world_abst.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜say_the_hello_world_impl.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂models
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂remote_source
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂absts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂models
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂reposit_impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜the_system_say_hello_world_reposit_impl.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂domain
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂entities
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂reposit_absts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜the_system_say_hello_world_reposit_abst.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂usecases
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜system_say_hello_world_usecase.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂states_holder
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂hello_world_bloc
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜hello_world_bloc.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜hello_world_event.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜hello_world_state.dart
┃ ┃ ┃ ┃ ┗ 📂ui
┃ ┃ ┃ ┃ ┃ ┣ 📂screens
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜welcome_screen.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂widgets
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┗ 📂shared
┃ ┃ ┃ ┣ 📂constants
┃ ┃ ┃ ┃ ┣ 📜colors_const.dart
┃ ┃ ┃ ┃ ┣ 📜double_const.dart
┃ ┃ ┃ ┃ ┣ 📜envs_const.dart
┃ ┃ ┃ ┃ ┣ 📜int_const.dart
┃ ┃ ┃ ┃ ┣ 📜lang_const.dart
┃ ┃ ┃ ┃ ┣ 📜routes_const.dart
┃ ┃ ┃ ┃ ┗ 📜string_const.dart
┃ ┃ ┃ ┣ 📂extensions
┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┣ 📂global
┃ ┃ ┃ ┃ ┗ 📜string_variable.dart
┃ ┃ ┃ ┣ 📂helpers
┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┣ 📂services
┃ ┃ ┃ ┃ ┣ 📂cache
┃ ┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜cache_instance.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂enums
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜shared_preference_enum.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂shared_preference_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜shared_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜shared_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜shared_put_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂shared_preference_streaming_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜stream_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜stream_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜stream_put_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂storage_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜storage_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜storage_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜storage_put_request.dart
┃ ┃ ┃ ┃ ┣ 📂connection
┃ ┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜connection_instance.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜connection_checker_request.dart
┃ ┃ ┃ ┃ ┣ 📂firebase
┃ ┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firebase_config.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firebase_instance.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂database
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜user_model.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂options
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂dev
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firebase_emulators_dev.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂staging
┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂analytics_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜analytic_get_event_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜analytic_observer_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂auth_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜phone_auth_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂firebase_storage_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firebase_storage_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firebase_storage_post_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂firestore_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firestore_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firestore_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firestore_post_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firestore_update_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂firestore_stream_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firestore_stream_get_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂utils
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜convert_util.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜root_util.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜status_util.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜string_util.dart
┃ ┃ ┃ ┃ ┣ 📂http
┃ ┃ ┃ ┃ ┃ ┣ 📂apis
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜account_api.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜dio_instance.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜http_overrides_helper.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜http_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜http_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜http_post_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜http_update_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜api_version.dart
┃ ┃ ┃ ┃ ┣ 📂image
┃ ┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜image_instance.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂messages
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜note_message.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜image_camera_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜image_compress_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜image_copper_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜image_gallery_request.dart
┃ ┃ ┃ ┃ ┣ 📂isar
┃ ┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_config.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜isar_instance.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂database
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂user_models
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂isar_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_post_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜isar_update_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂isar_stream_requests
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜isar_get_stream_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂utils
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜statuts_util.dart
┃ ┃ ┃ ┃ ┣ 📂jwt
┃ ┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜jwt_decode_request.dart
┃ ┃ ┃ ┃ ┗ 📂security
┃ ┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜decrypt_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜encrypt_request.dart
┃ ┃ ┃ ┗ 📂ui
┃ ┃ ┃ ┃ ┣ 📂screens
┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┗ 📂widgets
┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┗ 📜main.dart
┣ 📂test
┃ ┗ 📜.gitkeep
┣ 📜.gitignore
┣ 📜analysis_options.yaml
┗ 📜flutter_native_splash.yaml
```
## Lib Folder Structure Tree
```
📦lib
┣ 📂src
┃ ┣ 📂core
┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┣ 📂assets_config
┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┣ 📂injectors_config
┃ ┃ ┃ ┃ ┣ 📜injector.config.dart
┃ ┃ ┃ ┃ ┗ 📜injector.dart
┃ ┃ ┃ ┣ 📂language_config
┃ ┃ ┃ ┃ ┣ 📜translations_delegate.dart
┃ ┃ ┃ ┃ ┗ 📜translator.dart
┃ ┃ ┃ ┗ 📂windows_config
┃ ┃ ┃ ┃ ┗ 📜window_config.dart
┃ ┃ ┣ 📂router
┃ ┃ ┃ ┣ 📜auto_routes.dart
┃ ┃ ┃ ┗ 📜auto_routes.gr.dart
┃ ┃ ┣ 📂themes
┃ ┃ ┃ ┣ 📜dark_theme.dart
┃ ┃ ┃ ┗ 📜light_theme.dart
┃ ┃ ┗ 📜init.dart
┃ ┣ 📂modules
┃ ┃ ┗ 📂hello_world_mod
┃ ┃ ┃ ┣ 📂features
┃ ┃ ┃ ┃ ┗ 📂fetch_hello_world
┃ ┃ ┃ ┃ ┃ ┣ 📂data
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂local_source
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂absts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜say_the_hello_world_abst.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜say_the_hello_world_impl.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂models
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂remote_source
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂absts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂models
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂reposit_impls
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜the_system_say_hello_world_reposit_impl.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂domain
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂entities
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂reposit_absts
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜the_system_say_hello_world_reposit_abst.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂usecases
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜system_say_hello_world_usecase.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂states_holder
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂hello_world_bloc
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜hello_world_bloc.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜hello_world_event.dart
┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜hello_world_state.dart
┃ ┃ ┃ ┗ 📂ui
┃ ┃ ┃ ┃ ┣ 📂screens
┃ ┃ ┃ ┃ ┃ ┗ 📜welcome_screen.dart
┃ ┃ ┃ ┃ ┗ 📂widgets
┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┗ 📂shared
┃ ┃ ┣ 📂constants
┃ ┃ ┃ ┣ 📜colors_const.dart
┃ ┃ ┃ ┣ 📜double_const.dart
┃ ┃ ┃ ┣ 📜envs_const.dart
┃ ┃ ┃ ┣ 📜int_const.dart
┃ ┃ ┃ ┣ 📜lang_const.dart
┃ ┃ ┃ ┣ 📜routes_const.dart
┃ ┃ ┃ ┗ 📜string_const.dart
┃ ┃ ┣ 📂extensions
┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┣ 📂global
┃ ┃ ┃ ┗ 📜string_variable.dart
┃ ┃ ┣ 📂helpers
┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┣ 📂services
┃ ┃ ┃ ┣ 📂cache
┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┗ 📜cache_instance.dart
┃ ┃ ┃ ┃ ┣ 📂enums
┃ ┃ ┃ ┃ ┃ ┗ 📜shared_preference_enum.dart
┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┣ 📂shared_preference_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜shared_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜shared_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜shared_put_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂shared_preference_streaming_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜stream_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜stream_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜stream_put_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂storage_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜storage_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜storage_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜storage_put_request.dart
┃ ┃ ┃ ┣ 📂connection
┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┗ 📜connection_instance.dart
┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┗ 📜connection_checker_request.dart
┃ ┃ ┃ ┣ 📂firebase
┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┣ 📜firebase_config.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜firebase_instance.dart
┃ ┃ ┃ ┃ ┣ 📂database
┃ ┃ ┃ ┃ ┃ ┗ 📜user_model.dart
┃ ┃ ┃ ┃ ┣ 📂options
┃ ┃ ┃ ┃ ┃ ┣ 📂dev
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firebase_emulators_dev.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂staging
┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┣ 📂analytics_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜analytic_get_event_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜analytic_observer_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂auth_requests
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜phone_auth_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂firebase_storage_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firebase_storage_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firebase_storage_post_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📂firestore_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firestore_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firestore_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜firestore_post_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firestore_update_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂firestore_stream_requests
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜firestore_stream_get_request.dart
┃ ┃ ┃ ┃ ┗ 📂utils
┃ ┃ ┃ ┃ ┃ ┣ 📜convert_util.dart
┃ ┃ ┃ ┃ ┃ ┣ 📜root_util.dart
┃ ┃ ┃ ┃ ┃ ┣ 📜status_util.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜string_util.dart
┃ ┃ ┃ ┣ 📂http
┃ ┃ ┃ ┃ ┣ 📂apis
┃ ┃ ┃ ┃ ┃ ┗ 📜account_api.dart
┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┣ 📜dio_instance.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜http_overrides_helper.dart
┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┣ 📜http_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📜http_get_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📜http_post_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜http_update_request.dart
┃ ┃ ┃ ┃ ┗ 📜api_version.dart
┃ ┃ ┃ ┣ 📂image
┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┗ 📜image_instance.dart
┃ ┃ ┃ ┃ ┣ 📂messages
┃ ┃ ┃ ┃ ┃ ┗ 📜note_message.dart
┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┣ 📜image_camera_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📜image_compress_request.dart
┃ ┃ ┃ ┃ ┃ ┣ 📜image_copper_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜image_gallery_request.dart
┃ ┃ ┃ ┣ 📂isar
┃ ┃ ┃ ┃ ┣ 📂configs
┃ ┃ ┃ ┃ ┃ ┣ 📜isar_config.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜isar_instance.dart
┃ ┃ ┃ ┃ ┣ 📂database
┃ ┃ ┃ ┃ ┃ ┗ 📂user_models
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┃ ┣ 📂requests
┃ ┃ ┃ ┃ ┃ ┣ 📂isar_requests
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_delete_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_get_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜isar_post_request.dart
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜isar_update_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📂isar_stream_requests
┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜isar_get_stream_request.dart
┃ ┃ ┃ ┃ ┗ 📂utils
┃ ┃ ┃ ┃ ┃ ┗ 📜statuts_util.dart
┃ ┃ ┃ ┣ 📂jwt
┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┗ 📜jwt_decode_request.dart
┃ ┃ ┃ ┗ 📂security
┃ ┃ ┃ ┃ ┗ 📂requests
┃ ┃ ┃ ┃ ┃ ┣ 📜decrypt_request.dart
┃ ┃ ┃ ┃ ┃ ┗ 📜encrypt_request.dart
┃ ┃ ┗ 📂ui
┃ ┃ ┃ ┣ 📂screens
┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┃ ┃ ┃ ┗ 📂widgets
┃ ┃ ┃ ┃ ┗ 📜.gitkeep
┗ 📜main.dart
```
## Usage and Configuration
Once you have created your application or flutter project, you clone the architecture from Github, to start on a good basis
Note:
the predefined files, such as welcome.dart in the front end and other folders, as well as example_test file, are only files that will allow you to be on the right track and to get a good understanding of the architecture.
- step_1: Installation of pre_packages for pre-launch
Inside the pubspec.yaml file, you must integrate firstly the following dependencies :
```yaml
-----------StartUp Dependencies------------
flutter_localizations:
sdk: flutter
intl: ^last version
flutter_native_splash: ^last version
auto_route: ^last version
equatable: ^last version
get_it: ^last version
injectable: ^last version
flutter_bloc: ^last version
bloc: ^last version
multiple_result: ^last version
fluttertoast: ^last version
----------------------------
```
- step_1: Installation of dev_dependencies
Inside the pubspec.yaml file, you must integrate firstly the following packages :
```yaml
auto_route_generator: ^last version
injectable_generator: ^last version
build_runner: ^last version
```
these packages will allow you to easily activate the various files imported into the architecture.
then, you just have to follow, the readme.md in the folder **assets**
- step_2: Integration of the architecture
once in the Clean and Modular Architecture folder, you copy all its content to paste it in your project.
- Bonus: The dependencies you need for the various services and config
- ### Cache
```yaml
flutter_secure_storage: ^last version
shared_preferences: ^last version
streaming_shared_preferences: ^last version
```
- ### Connexion
```yaml
internet_connection_checker_plus: ^last version
```
- ### Firebase
```yaml
firebase_core: ^last version
firebase_app_check: ^last version
firebase_auth: ^last version
cloud_firestore: ^last version
firebase_storage: ^last version
firebase_messaging: ^last version
firebase_crashlytics: ^last version
firebase_analytics: ^last version
cloud_functions: ^last version
```
- ### Http
```yaml
dio: ^last version
```
- ### Image
```yaml
image_picker: ^last version
flutter_native_image: ^last version
image_cropper: ^last version
```
- ### Isar
```yaml
isar: ^last version
isar_flutter_libs: ^last version
isar_generator: ^last version
```
- ### Jwt
```yaml
jwt_decoder: ^last version
```
- ### assets_gen
```yaml
flutter_svg: ^last version
flutter_gen: ^last version
flutter_gen_runner: ^last version
```
add this following line in
pubspec.yaml
```yaml
flutter_gen:
# Optional
output: lib/src/core/configs/assets_config
# Optional
line_length: 80
# Optional
parse_metadata: false
# Optional
integrations:
flutter_svg: true
flare_flutter: true
rive: true
lottie: false
assets:
# Optional
enabled: true
# Optional
outputs:
# Optional
# Set to true if you want this package to be a package dependency
# See: https://flutter.dev/docs/development/ui/assets-and-images#from-packages
package_parameter_enabled: true
# Optional
# Available values:
# - camel-case
# - snake-case
# - dot-delimiter
style: dot-delimiter
class_name: Assets
exclude: []
fonts:
# Optional
enabled: true
# Optional
outputs:
class_name: FontFamily
```
after you read the doc : https://pub.dev/packages/flutter_gen
- ### test
add in dev_dependencies
```yaml
bloc_test: ^last version
mocktail: ^last version
integration_test:
sdk: flutter
```
---
Copyright © 2024 James Brel All Rights Reserved