https://github.com/vnapnic/flutter_clean_architecture
Flutter clean architecture
https://github.com/vnapnic/flutter_clean_architecture
architecture bloc ci-cd clean-architecture cubit dart flutter flutter-architecture indentation intellij lefthook mvvm runner
Last synced: about 2 months ago
JSON representation
Flutter clean architecture
- Host: GitHub
- URL: https://github.com/vnapnic/flutter_clean_architecture
- Owner: VNAPNIC
- Created: 2020-10-02T04:22:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T21:04:29.000Z (over 2 years ago)
- Last Synced: 2025-04-30T20:32:23.977Z (5 months ago)
- Topics: architecture, bloc, ci-cd, clean-architecture, cubit, dart, flutter, flutter-architecture, indentation, intellij, lefthook, mvvm, runner
- Language: Dart
- Homepage:
- Size: 3 MB
- Stars: 137
- Watchers: 4
- Forks: 62
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
## Supported Null safety
### Project architecture (Clean Architecture Approach)
##### 1. Why:
* We want to determine what types of database that we use for storage (might want to change it later on)
* We want to adhere to SOLID principles since we are using OOP for this project.
* We want to ensure that UI layers do not care what is going on at the data layer at all.
* We might want to separate each layer into different packages.
##### 2. Presentation - Domain - Data - models.
##### 3. Presentation layer consist of
* Widgets
* Cubit
* Cubit only manages UI state based on business logic
##### 4. Domain layer (Business logic layer)
* Entities (or models that UI needs)
* Usecases (user stories)
* Repositories interface
* Typically one function, but can be more if functions are related.
* Remember, one class has one responsibility only.
##### 5. Data layer (Data access layer)
* source
* remotes (API)
* locals (Database)
* Repositories (Implementation from Domain layer)
##### 6. Models (The `data model` common for domain layer and data layer)
* models
* request
* response
We build this class working separately and not following logics of `Domain layer`. However, `Repositories` will still implement from `Domain layer`, but the `Domain layer` will follow each function, and the `Data layer` will follow the cluster of data defined on the server.
For example: `Domain layer` has defined 2 layers of Login and Register features, but these two features are related to the API User cluster on the server, so in the `Data layer`, there will only be one Repo which is user and that Repo will implement 2 layers Login and Register of the `Domain layer`.
##### 6. More insight of layers
### DI pattern
`Dependency Injection` is a great design pattern that allows us to eliminate rigid dependencies between elements and it makes the application more flexible, easy to expand scales and maintain.
In the project we use Plugin `get_it` and `injectable` to implement DI and we have also defined classes so you can easily implement `DI` in the `DI layer`.
### Routes
The project has predefined Named routes RouteDefine + manifest
##### 1. RouteDefine
* All routes must extend this class.
* When extending, you will have to override func "initRoute", here you will define your routes.
* A feature may have multiple routes with different input arguments.
* Make sure that the ID of each route in your project is unique.
##### 2. manifest - `lib/manifest.dart`
* To add a route to the project you just need to declare in the func "generateRoute". Each route will be provided with a func "build", you must call it in the func "generateRoute" of "manifest" to register.
### Network.
* Project can use retrofit to work with the alternative network for http.
* Retrofit is pre-installed in the "ApiModule.dart". You can customize it here
* All interceptors are defined in the /configuration/lib/network/interceptor/* class
* To work with Certificate, please refer to the "/configuration/lib/network/http_overrides.dart" class, with the default the project accept badCertificate
### Development environment settings.
* All flavor environments are installed in the "/configuration/lib/environment/buid_config.dart" class.
* Basically we are defining 4 development environments: development, staging, preprod and release.
* Run App
You can run the app using the commands
```
## development: flutter run -t lib/main.dart --debug --flavor beta
## staging: flutter run -t lib/main.dart --debug --flavor prod
```
##### Build App
You can build the app using the commands
for Android
```
## development: flutter build apk -t lib/main.dart --flavor beta
## staging: flutter build apk -t lib/main.dart --flavor prod
```
for IOS
```
## development flutter build ios -t lib/main.dart --flavor beta
## staging: flutter build ios -t lib/main.dart --flavor prod
```
### resources
* All resources (images, fonts, videos, ...) must be placed in the assets class
* Before using them, please declare the path in utility class and the suffix of the class to be type_provide (image_provide.dart)
### Getting started
Get dependencies and generate necessary files.
```
npm run init
```
We'll handle the generation of required files for 🚀 your onboarding!
### Json parsing / serialization
This project is implementing [json_serializable](https://pub.dev/packages/json_serializable).
It use build_runner to generate files. If you make a change to these files, you need to re-run the generator using build_runner:
```
flutter pub run build_runner build
```
generator using build_runner and remove conflict file :
```
npm run generate
```
## Indentation.
- Auto indentation handled with git hook using [Lefthook](https://github.com/Arkweid/lefthook).
- For mac users, run `npm run setup` and you should be done. More details below.
- This project use npm for [Lefthook](https://github.com/Arkweid/lefthook) installation, to ease others getting it up running fast - run `npm install`
- After installation, run `npx lefthook install` to finish up installation.
- More info [here](https://github.com/Arkweid/lefthook/blob/master/docs/node.md).
### Localization
Using this library to handle multi-languages. Follow this guide to understand and config languages files
#### Setup Step :
* VSC, AS, IJ users need to install the plugins from the market.
* vs-code: https://marketplace.visualstudio.com/items?itemName=localizely.flutter-intl
* intelliJ / android studio: https://plugins.jetbrains.com/plugin/13666-flutter-intl
* others/CLI:
```
flutter pub global activate intl_utils
flutter pub global run intl_utils:generate
```
### Initialize plugins (IntelliJ reference)
1. Open Flutter intl in `Action`
2. Click on `arb File`
3. To add / remove Locale, choose `Add Locale` / `Remove Locale`
4. Then it will promp which locale
**Current available locale is en, en**
Link library : https://pub.dev/packages/intl_utils
## Visitors Count
