16 |
17 |
18 |
19 | ```
20 | lib/
21 | ├── src/
22 | │ ├── common_widgets/
23 | │ │ └── common_button.dart
24 | │ ├── constants/
25 | │ │ └── colors.dart
26 | │ ├── exceptions/
27 | │ │ └── routing_exception.dart
28 | │ ├── features/
29 | │ │ ├── address/
30 | │ │ │ ├── data/
31 | │ │ │ │ ├── datasources/
32 | │ │ │ │ │ └── address_datasources.dart
33 | │ │ │ │ ├── models/
34 | │ │ │ │ │ └── address_model.dart
35 | │ │ │ │ └── repositories/
36 | │ │ │ │ └── address_repositories.dart
37 | │ │ │ ├── domain/
38 | │ │ │ │ ├── entities/
39 | │ │ │ │ │ └── address_entities.dart
40 | │ │ │ │ ├── repositories/
41 | │ │ │ │ │ └── address_repositories.dart
42 | │ │ │ │ └── usecases/
43 | │ │ │ │ └── address_usecases.dart
44 | │ │ │ └── presentation/
45 | │ │ │ ├── bloc/
46 | │ │ │ │ ├── address_bloc.dart
47 | │ │ │ │ ├── address_event.dart
48 | │ │ │ │ └── address_state.dart
49 | │ │ │ ├── pages/
50 | │ │ │ │ └── address_page.dart
51 | │ │ │ └── widgets/
52 | │ │ │ └── address_widgets.dart
53 | │ │ ├── authentication/
54 | │ │ │ └── (...)
55 | │ │ ├── cart/
56 | │ │ │ └── (...)
57 | │ │ ├── checkout/
58 | │ │ │ └── (...)
59 | │ │ ├── orders/
60 | │ │ │ └── (...)
61 | │ │ └── products/
62 | │ │ └── (...)
63 | │ ├── localization/
64 | │ │ ├── app_bn.arb
65 | │ │ ├── app_en.arb
66 | │ │ └── localization.dart
67 | │ ├── routing/
68 | │ │ └── routing.dart
69 | │ └── utils/
70 | │ └── utils.dart
71 | └── main.dart
72 | ```
73 |
74 | You might notice that some files are just dummy (like api.dart, model.dart).
75 | They are placed there just for git to take the folder structure into consideration.
76 | Leaving those folders empty won't let git to take them into consideration. Since this is mostly a startup project, I was thinking of offering you the standard folder structure from the start. Of course, this may change multiple times, improving every time more and more.
77 |
78 | ## Why this design pattern?
79 |
80 |
81 |
82 | This architecture is made of four distinct layers, each containing the components that our app needs:
83 |
84 | ```
85 | ➮ presentation: widgets, states, and controllers
86 | ➮ application: services
87 | ➮ domain: models
88 | ➮ data: repositories, data sources,
89 | and DTOs (data transfer objects)
90 | ```
91 |
92 | Of course, if we're building just a single-page app, we can put all files in one folder and call it a day. 😎
93 |
94 | But as soon as we start adding more pages and have various data models to deal with, how can we organize all our files in a consistent way?
95 |
96 | In practice, a feature-first or layer-first approach is often used.
97 |
98 |
Layer-first: Drawbacks
99 |
100 | This approach is easy to use in practice, but doesn't scale very well as the app grows.
101 |
102 | For any given feature, files that belong to different layers are far away from each other. And this makes it harder to work on individual features because we have to keep jumping to different parts of the project.
103 |
104 | And if we decide that we want to delete a feature, it's far too easy to forget certain files, because they are all organized by layer.
105 |
106 | For these reasons, the feature-first approach is often a better choice when building medium/large apps.
107 |
108 |
What about shared code?
109 |
110 | Of course, when building real apps you'll find that your code doesn't always fit neatly into specific folders as you intended.
111 |
112 | What if two or more separate features need to share some widgets or model classes?
113 |
114 | In these cases, it's easy to end up with folders called `shared` or `common`, or `utils`.
115 |
116 | But how should these folders themselves be organized? And how do you prevent them from becoming a dumping ground for all sorts of files?
117 |
118 | If your app has 20 features and has some code that needs to be shared by only two of them, should it really belong to a top-level `shared` folder?
119 |
120 | What if it's shared among 5 features? Or 10?
121 |
122 | In this scenario, there is no right or wrong answer, and you have to use your best judgement on a case-by-case basis.
123 |
124 | ## What is a `feature`?
125 |
126 |
127 |
128 | `Feature-first is not about the UI!`
129 |
130 | Feature is not about what the user sees, but what the user does:
131 |
132 | ```
133 | ➮ authenticate
134 | ➮ manage the shopping cart
135 | ➮ checkout
136 | ➮ view all past orders
137 | ➮ leave a review
138 | ```
139 |
140 | In other words, a feature is a functional requirement that helps the user complete a given task.
141 |
142 | And using some hints from domain-driven design, I decided to organize the project structure around the domain layer.
143 |
144 | Once I figured that out, everything fell into place. And I ended up with seven functional areas that you can see on the right.
145 |
146 | Note that with this approach is still possible for code inside a given feature to depend on code from a different feature. For example:
147 |
148 | ```
149 | ➮ the product page shows a list of reviews
150 | ➮ the orders page shows some product information
151 | ➮ the checkout flow requires the user to authenticate first
152 | ```
153 |
154 | But we end up with far fewer files that are shared across all features, and the entire structure is much more balanced.
155 |
156 | ## How to do `feature-first`, the right way?
157 |
158 | In summary, the feature-first approach lets us structure our project around the functional requirements of our app.
159 |
160 | So here's how to use this correctly in your own apps:
161 |
162 | ☞ start from the domain layer and identify the model classes and business logic for manipulating them
163 | ☞ create a folder for each model (or group of models) that belong together
164 | ☞ within that folder, create the `presentation`, `application`, `domain`, `data` sub-folders as needed
165 | ☞ inside each sub-folder, add all the files you need
166 |
--------------------------------------------------------------------------------
/analysis_options.yaml:
--------------------------------------------------------------------------------
1 | # This file configures the analyzer, which statically analyzes Dart code to
2 | # check for errors, warnings, and lints.
3 | #
4 | # The issues identified by the analyzer are surfaced in the UI of Dart-enabled
5 | # IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
6 | # invoked from the command line by running `flutter analyze`.
7 |
8 | # The following line activates a set of recommended lints for Flutter apps,
9 | # packages, and plugins designed to encourage good coding practices.
10 | include: package:flutter_lints/flutter.yaml
11 |
12 | linter:
13 | # The lint rules applied to this project can be customized in the
14 | # section below to disable rules from the `package:flutter_lints/flutter.yaml`
15 | # included above or to enable additional rules. A list of all available lints
16 | # and their documentation is published at
17 | # https://dart-lang.github.io/linter/lints/index.html.
18 | #
19 | # Instead of disabling a lint rule for the entire project in the
20 | # section below, it can also be suppressed for a single line of code
21 | # or a specific dart file by using the `// ignore: name_of_lint` and
22 | # `// ignore_for_file: name_of_lint` syntax on the line or in the file
23 | # producing the lint.
24 | rules:
25 | # avoid_print: false # Uncomment to disable the `avoid_print` rule
26 | # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
27 |
28 | # Additional information about this file can be found at
29 | # https://dart.dev/guides/language/analysis-options
30 |
--------------------------------------------------------------------------------
/android/.gitignore:
--------------------------------------------------------------------------------
1 | gradle-wrapper.jar
2 | /.gradle
3 | /captures/
4 | /gradlew
5 | /gradlew.bat
6 | /local.properties
7 | GeneratedPluginRegistrant.java
8 |
9 | # Remember to never publicly share your keystore.
10 | # See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
11 | key.properties
12 | **/*.keystore
13 | **/*.jks
14 |
--------------------------------------------------------------------------------
/android/app/build.gradle:
--------------------------------------------------------------------------------
1 | def localProperties = new Properties()
2 | def localPropertiesFile = rootProject.file('local.properties')
3 | if (localPropertiesFile.exists()) {
4 | localPropertiesFile.withReader('UTF-8') { reader ->
5 | localProperties.load(reader)
6 | }
7 | }
8 |
9 | def flutterRoot = localProperties.getProperty('flutter.sdk')
10 | if (flutterRoot == null) {
11 | throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
12 | }
13 |
14 | def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
15 | if (flutterVersionCode == null) {
16 | flutterVersionCode = '1'
17 | }
18 |
19 | def flutterVersionName = localProperties.getProperty('flutter.versionName')
20 | if (flutterVersionName == null) {
21 | flutterVersionName = '1.0'
22 | }
23 |
24 | apply plugin: 'com.android.application'
25 | apply plugin: 'kotlin-android'
26 | apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
27 |
28 | android {
29 | namespace "com.example.scalable_app_architecture"
30 | compileSdkVersion flutter.compileSdkVersion
31 | ndkVersion flutter.ndkVersion
32 |
33 | compileOptions {
34 | sourceCompatibility JavaVersion.VERSION_1_8
35 | targetCompatibility JavaVersion.VERSION_1_8
36 | }
37 |
38 | kotlinOptions {
39 | jvmTarget = '1.8'
40 | }
41 |
42 | sourceSets {
43 | main.java.srcDirs += 'src/main/kotlin'
44 | }
45 |
46 | defaultConfig {
47 | // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
48 | applicationId "com.example.scalable_app_architecture"
49 | // You can update the following values to match your application needs.
50 | // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
51 | minSdkVersion flutter.minSdkVersion
52 | targetSdkVersion flutter.targetSdkVersion
53 | versionCode flutterVersionCode.toInteger()
54 | versionName flutterVersionName
55 | }
56 |
57 | buildTypes {
58 | release {
59 | // TODO: Add your own signing config for the release build.
60 | // Signing with the debug keys for now, so `flutter run --release` works.
61 | signingConfig signingConfigs.debug
62 | }
63 | }
64 | }
65 |
66 | flutter {
67 | source '../..'
68 | }
69 |
70 | dependencies {
71 | implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
72 | }
73 |
--------------------------------------------------------------------------------
/android/app/src/debug/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/android/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
14 |
18 |
22 |
23 |
24 |
25 |
26 |
27 |
29 |
32 |
33 |
34 |
--------------------------------------------------------------------------------
/android/app/src/main/kotlin/com/example/scalable_app_architecture/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package com.example.scalable_app_architecture
2 |
3 | import io.flutter.embedding.android.FlutterActivity
4 |
5 | class MainActivity: FlutterActivity() {
6 | }
7 |
--------------------------------------------------------------------------------
/android/app/src/main/res/drawable-v21/launch_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
12 |
13 |
--------------------------------------------------------------------------------
/android/app/src/main/res/drawable/launch_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
12 |
13 |
--------------------------------------------------------------------------------
/android/app/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/android/app/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/android/app/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/android/app/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/android/app/src/main/res/values-night/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
9 |
15 |
18 |
19 |
--------------------------------------------------------------------------------
/android/app/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
9 |
15 |
18 |
19 |
--------------------------------------------------------------------------------
/android/app/src/profile/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/android/build.gradle:
--------------------------------------------------------------------------------
1 | buildscript {
2 | ext.kotlin_version = '1.7.10'
3 | repositories {
4 | google()
5 | mavenCentral()
6 | }
7 |
8 | dependencies {
9 | classpath 'com.android.tools.build:gradle:7.3.0'
10 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
11 | }
12 | }
13 |
14 | allprojects {
15 | repositories {
16 | google()
17 | mavenCentral()
18 | }
19 | }
20 |
21 | rootProject.buildDir = '../build'
22 | subprojects {
23 | project.buildDir = "${rootProject.buildDir}/${project.name}"
24 | }
25 | subprojects {
26 | project.evaluationDependsOn(':app')
27 | }
28 |
29 | tasks.register("clean", Delete) {
30 | delete rootProject.buildDir
31 | }
32 |
--------------------------------------------------------------------------------
/android/gradle.properties:
--------------------------------------------------------------------------------
1 | org.gradle.jvmargs=-Xmx1536M
2 | android.useAndroidX=true
3 | android.enableJetifier=true
4 |
--------------------------------------------------------------------------------
/android/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | zipStoreBase=GRADLE_USER_HOME
4 | zipStorePath=wrapper/dists
5 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip
6 |
--------------------------------------------------------------------------------
/android/settings.gradle:
--------------------------------------------------------------------------------
1 | include ':app'
2 |
3 | def localPropertiesFile = new File(rootProject.projectDir, "local.properties")
4 | def properties = new Properties()
5 |
6 | assert localPropertiesFile.exists()
7 | localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) }
8 |
9 | def flutterSdkPath = properties.getProperty("flutter.sdk")
10 | assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
11 | apply from: "$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle"
12 |
--------------------------------------------------------------------------------
/ios/.gitignore:
--------------------------------------------------------------------------------
1 | **/dgph
2 | *.mode1v3
3 | *.mode2v3
4 | *.moved-aside
5 | *.pbxuser
6 | *.perspectivev3
7 | **/*sync/
8 | .sconsign.dblite
9 | .tags*
10 | **/.vagrant/
11 | **/DerivedData/
12 | Icon?
13 | **/Pods/
14 | **/.symlinks/
15 | profile
16 | xcuserdata
17 | **/.generated/
18 | Flutter/App.framework
19 | Flutter/Flutter.framework
20 | Flutter/Flutter.podspec
21 | Flutter/Generated.xcconfig
22 | Flutter/ephemeral/
23 | Flutter/app.flx
24 | Flutter/app.zip
25 | Flutter/flutter_assets/
26 | Flutter/flutter_export_environment.sh
27 | ServiceDefinitions.json
28 | Runner/GeneratedPluginRegistrant.*
29 |
30 | # Exceptions to above rules.
31 | !default.mode1v3
32 | !default.mode2v3
33 | !default.pbxuser
34 | !default.perspectivev3
35 |
--------------------------------------------------------------------------------
/ios/Flutter/AppFrameworkInfo.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | CFBundleDevelopmentRegion
6 | en
7 | CFBundleExecutable
8 | App
9 | CFBundleIdentifier
10 | io.flutter.flutter.app
11 | CFBundleInfoDictionaryVersion
12 | 6.0
13 | CFBundleName
14 | App
15 | CFBundlePackageType
16 | FMWK
17 | CFBundleShortVersionString
18 | 1.0
19 | CFBundleSignature
20 | ????
21 | CFBundleVersion
22 | 1.0
23 | MinimumOSVersion
24 | 11.0
25 |
26 |
27 |
--------------------------------------------------------------------------------
/ios/Flutter/Debug.xcconfig:
--------------------------------------------------------------------------------
1 | #include "Generated.xcconfig"
2 |
--------------------------------------------------------------------------------
/ios/Flutter/Release.xcconfig:
--------------------------------------------------------------------------------
1 | #include "Generated.xcconfig"
2 |
--------------------------------------------------------------------------------
/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata:
--------------------------------------------------------------------------------
1 |
2 |
4 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | IDEDidComputeMac32BitWarning
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | PreviewsEnabled
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme:
--------------------------------------------------------------------------------
1 |
2 |
5 |
8 |
9 |
15 |
21 |
22 |
23 |
24 |
25 |
30 |
31 |
37 |
38 |
39 |
40 |
43 |
49 |
50 |
51 |
52 |
53 |
63 |
65 |
71 |
72 |
73 |
74 |
80 |
82 |
88 |
89 |
90 |
91 |
93 |
94 |
97 |
98 |
99 |
--------------------------------------------------------------------------------
/ios/Runner.xcworkspace/contents.xcworkspacedata:
--------------------------------------------------------------------------------
1 |
2 |
4 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | IDEDidComputeMac32BitWarning
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | PreviewsEnabled
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/ios/Runner/AppDelegate.swift:
--------------------------------------------------------------------------------
1 | import UIKit
2 | import Flutter
3 |
4 | @UIApplicationMain
5 | @objc class AppDelegate: FlutterAppDelegate {
6 | override func application(
7 | _ application: UIApplication,
8 | didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
9 | ) -> Bool {
10 | GeneratedPluginRegistrant.register(with: self)
11 | return super.application(application, didFinishLaunchingWithOptions: launchOptions)
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json:
--------------------------------------------------------------------------------
1 | {
2 | "images" : [
3 | {
4 | "size" : "20x20",
5 | "idiom" : "iphone",
6 | "filename" : "Icon-App-20x20@2x.png",
7 | "scale" : "2x"
8 | },
9 | {
10 | "size" : "20x20",
11 | "idiom" : "iphone",
12 | "filename" : "Icon-App-20x20@3x.png",
13 | "scale" : "3x"
14 | },
15 | {
16 | "size" : "29x29",
17 | "idiom" : "iphone",
18 | "filename" : "Icon-App-29x29@1x.png",
19 | "scale" : "1x"
20 | },
21 | {
22 | "size" : "29x29",
23 | "idiom" : "iphone",
24 | "filename" : "Icon-App-29x29@2x.png",
25 | "scale" : "2x"
26 | },
27 | {
28 | "size" : "29x29",
29 | "idiom" : "iphone",
30 | "filename" : "Icon-App-29x29@3x.png",
31 | "scale" : "3x"
32 | },
33 | {
34 | "size" : "40x40",
35 | "idiom" : "iphone",
36 | "filename" : "Icon-App-40x40@2x.png",
37 | "scale" : "2x"
38 | },
39 | {
40 | "size" : "40x40",
41 | "idiom" : "iphone",
42 | "filename" : "Icon-App-40x40@3x.png",
43 | "scale" : "3x"
44 | },
45 | {
46 | "size" : "60x60",
47 | "idiom" : "iphone",
48 | "filename" : "Icon-App-60x60@2x.png",
49 | "scale" : "2x"
50 | },
51 | {
52 | "size" : "60x60",
53 | "idiom" : "iphone",
54 | "filename" : "Icon-App-60x60@3x.png",
55 | "scale" : "3x"
56 | },
57 | {
58 | "size" : "20x20",
59 | "idiom" : "ipad",
60 | "filename" : "Icon-App-20x20@1x.png",
61 | "scale" : "1x"
62 | },
63 | {
64 | "size" : "20x20",
65 | "idiom" : "ipad",
66 | "filename" : "Icon-App-20x20@2x.png",
67 | "scale" : "2x"
68 | },
69 | {
70 | "size" : "29x29",
71 | "idiom" : "ipad",
72 | "filename" : "Icon-App-29x29@1x.png",
73 | "scale" : "1x"
74 | },
75 | {
76 | "size" : "29x29",
77 | "idiom" : "ipad",
78 | "filename" : "Icon-App-29x29@2x.png",
79 | "scale" : "2x"
80 | },
81 | {
82 | "size" : "40x40",
83 | "idiom" : "ipad",
84 | "filename" : "Icon-App-40x40@1x.png",
85 | "scale" : "1x"
86 | },
87 | {
88 | "size" : "40x40",
89 | "idiom" : "ipad",
90 | "filename" : "Icon-App-40x40@2x.png",
91 | "scale" : "2x"
92 | },
93 | {
94 | "size" : "76x76",
95 | "idiom" : "ipad",
96 | "filename" : "Icon-App-76x76@1x.png",
97 | "scale" : "1x"
98 | },
99 | {
100 | "size" : "76x76",
101 | "idiom" : "ipad",
102 | "filename" : "Icon-App-76x76@2x.png",
103 | "scale" : "2x"
104 | },
105 | {
106 | "size" : "83.5x83.5",
107 | "idiom" : "ipad",
108 | "filename" : "Icon-App-83.5x83.5@2x.png",
109 | "scale" : "2x"
110 | },
111 | {
112 | "size" : "1024x1024",
113 | "idiom" : "ios-marketing",
114 | "filename" : "Icon-App-1024x1024@1x.png",
115 | "scale" : "1x"
116 | }
117 | ],
118 | "info" : {
119 | "version" : 1,
120 | "author" : "xcode"
121 | }
122 | }
123 |
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json:
--------------------------------------------------------------------------------
1 | {
2 | "images" : [
3 | {
4 | "idiom" : "universal",
5 | "filename" : "LaunchImage.png",
6 | "scale" : "1x"
7 | },
8 | {
9 | "idiom" : "universal",
10 | "filename" : "LaunchImage@2x.png",
11 | "scale" : "2x"
12 | },
13 | {
14 | "idiom" : "universal",
15 | "filename" : "LaunchImage@3x.png",
16 | "scale" : "3x"
17 | }
18 | ],
19 | "info" : {
20 | "version" : 1,
21 | "author" : "xcode"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/md-siam/scalable_app_architecture/bd0c497763ea73b07be3fb89b6bba1d1e2121213/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png
--------------------------------------------------------------------------------
/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md:
--------------------------------------------------------------------------------
1 | # Launch Screen Assets
2 |
3 | You can customize the launch screen with your own desired assets by replacing the image files in this directory.
4 |
5 | You can also do it by opening your Flutter project's Xcode project with `open ios/Runner.xcworkspace`, selecting `Runner/Assets.xcassets` in the Project Navigator and dropping in the desired images.
--------------------------------------------------------------------------------
/ios/Runner/Base.lproj/LaunchScreen.storyboard:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
--------------------------------------------------------------------------------
/ios/Runner/Base.lproj/Main.storyboard:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/ios/Runner/Info.plist:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | CFBundleDevelopmentRegion
6 | $(DEVELOPMENT_LANGUAGE)
7 | CFBundleDisplayName
8 | Scalable App Architecture
9 | CFBundleExecutable
10 | $(EXECUTABLE_NAME)
11 | CFBundleIdentifier
12 | $(PRODUCT_BUNDLE_IDENTIFIER)
13 | CFBundleInfoDictionaryVersion
14 | 6.0
15 | CFBundleName
16 | scalable_app_architecture
17 | CFBundlePackageType
18 | APPL
19 | CFBundleShortVersionString
20 | $(FLUTTER_BUILD_NAME)
21 | CFBundleSignature
22 | ????
23 | CFBundleVersion
24 | $(FLUTTER_BUILD_NUMBER)
25 | LSRequiresIPhoneOS
26 |
27 | UILaunchStoryboardName
28 | LaunchScreen
29 | UIMainStoryboardFile
30 | Main
31 | UISupportedInterfaceOrientations
32 |
33 | UIInterfaceOrientationPortrait
34 | UIInterfaceOrientationLandscapeLeft
35 | UIInterfaceOrientationLandscapeRight
36 |
37 | UISupportedInterfaceOrientations~ipad
38 |
39 | UIInterfaceOrientationPortrait
40 | UIInterfaceOrientationPortraitUpsideDown
41 | UIInterfaceOrientationLandscapeLeft
42 | UIInterfaceOrientationLandscapeRight
43 |
44 | UIViewControllerBasedStatusBarAppearance
45 |
46 | CADisableMinimumFrameDurationOnPhone
47 |
48 | UIApplicationSupportsIndirectInputEvents
49 |
50 |
51 |
52 |
--------------------------------------------------------------------------------
/ios/Runner/Runner-Bridging-Header.h:
--------------------------------------------------------------------------------
1 | #import "GeneratedPluginRegistrant.h"
2 |
--------------------------------------------------------------------------------
/ios/RunnerTests/RunnerTests.swift:
--------------------------------------------------------------------------------
1 | import Flutter
2 | import UIKit
3 | import XCTest
4 |
5 | class RunnerTests: XCTestCase {
6 |
7 | func testExample() {
8 | // If you add code to the Runner application, consider adding tests here.
9 | // See https://developer.apple.com/documentation/xctest for more information about using XCTest.
10 | }
11 |
12 | }
13 |
--------------------------------------------------------------------------------
/lib/main.dart:
--------------------------------------------------------------------------------
1 | import 'package:flutter/material.dart';
2 |
3 | void main() {
4 | runApp(const MyApp());
5 | }
6 |
7 | class MyApp extends StatelessWidget {
8 | const MyApp({Key? key}) : super(key: key);
9 |
10 | @override
11 | Widget build(BuildContext context) {
12 | return MaterialApp(
13 | title: 'Scalable App Architecture',
14 | debugShowCheckedModeBanner: false,
15 | theme: ThemeData(primarySwatch: Colors.blue),
16 | home: const MyHomePage(title: 'Flutter Demo Home Page'),
17 | );
18 | }
19 | }
20 |
21 | class MyHomePage extends StatefulWidget {
22 | const MyHomePage({Key? key, required this.title}) : super(key: key);
23 |
24 | final String title;
25 |
26 | @override
27 | State createState() => _MyHomePageState();
28 | }
29 |
30 | class _MyHomePageState extends State {
31 | int _counter = 0;
32 |
33 | void _incrementCounter() {
34 | setState(() {
35 | _counter++;
36 | });
37 | }
38 |
39 | @override
40 | Widget build(BuildContext context) {
41 | return Scaffold(
42 | appBar: AppBar(
43 | title: Text(widget.title),
44 | ),
45 | body: Center(
46 | child: Column(
47 | mainAxisAlignment: MainAxisAlignment.center,
48 | children: [
49 | const Text(
50 | 'You have pushed the button this many times:',
51 | ),
52 | Text(
53 | '$_counter',
54 | style: Theme.of(context).textTheme.headlineMedium,
55 | ),
56 | ],
57 | ),
58 | ),
59 | floatingActionButton: FloatingActionButton(
60 | onPressed: _incrementCounter,
61 | tooltip: 'Increment',
62 | child: const Icon(Icons.add),
63 | ),
64 | );
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/lib/src/common_widgets/common_button.dart:
--------------------------------------------------------------------------------
1 | // dummy
--------------------------------------------------------------------------------
/lib/src/constants/colors.dart:
--------------------------------------------------------------------------------
1 | // dummy colors
--------------------------------------------------------------------------------
/lib/src/exceptions/routing_exception.dart:
--------------------------------------------------------------------------------
1 | // dummy exception
--------------------------------------------------------------------------------
/lib/src/features/address/data/datasources/address_datasources.dart:
--------------------------------------------------------------------------------
1 | // dummy datasources
--------------------------------------------------------------------------------
/lib/src/features/address/data/models/address_model.dart:
--------------------------------------------------------------------------------
1 | // dummy file
--------------------------------------------------------------------------------
/lib/src/features/address/data/repositories/address_repositories.dart:
--------------------------------------------------------------------------------
1 | // dummy file
--------------------------------------------------------------------------------
/lib/src/features/address/domain/entities/address_entities.dart:
--------------------------------------------------------------------------------
1 | // dummy file
--------------------------------------------------------------------------------
/lib/src/features/address/domain/repositories/address_repositories.dart:
--------------------------------------------------------------------------------
1 | // dummy file
--------------------------------------------------------------------------------
/lib/src/features/address/domain/usecases/address_usecases.dart:
--------------------------------------------------------------------------------
1 | // dummy file
--------------------------------------------------------------------------------
/lib/src/features/address/presentation/bloc/address_bloc.dart:
--------------------------------------------------------------------------------
1 | import 'package:bloc/bloc.dart';
2 | import 'package:equatable/equatable.dart';
3 |
4 | part 'address_event.dart';
5 | part 'address_state.dart';
6 |
7 | class AddressBloc extends Bloc {
8 | AddressBloc() : super(AddressInitial()) {
9 | on((event, emit) {
10 | // TODO: implement event handler
11 | });
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/lib/src/features/address/presentation/bloc/address_event.dart:
--------------------------------------------------------------------------------
1 | part of 'address_bloc.dart';
2 |
3 | abstract class AddressEvent extends Equatable {
4 | const AddressEvent();
5 |
6 | @override
7 | List
2 | 
3 | 
5 | 
6 |
7 | # Scalable App Architecture - [CodeWithAndrea](https://codewithandrea.com/articles/flutter-project-structure/)
8 |
9 | 
10 |
11 | This scalable app architecture design is inspired by [Andrea Bizzotto](https://github.com/bizz84). Full documentation of this design can be found [here](https://codewithandrea.com/articles/flutter-project-structure/). In addition to that, you can use a VSCode extension called [Flutter Feature Scaffolding](https://marketplace.visualstudio.com/items?itemName=KiritchoukC.flutter-clean-architecture) for easily generating the features' folders. This design is using BLoC state-management solution, and for more information on BLoC library, I would strongly suggest you to follow their official [documentation](https://bloclibrary.dev).
12 |
13 | This project contains everything that you will need in order to immediately start developing your highly scaled application. You can also call this folder structure as Feature-first (layers inside features) design.
14 |
15 | 
18 |
19 | ```
20 | lib/
21 | ├── src/
22 | │ ├── common_widgets/
23 | │ │ └── common_button.dart
24 | │ ├── constants/
25 | │ │ └── colors.dart
26 | │ ├── exceptions/
27 | │ │ └── routing_exception.dart
28 | │ ├── features/
29 | │ │ ├── address/
30 | │ │ │ ├── data/
31 | │ │ │ │ ├── datasources/
32 | │ │ │ │ │ └── address_datasources.dart
33 | │ │ │ │ ├── models/
34 | │ │ │ │ │ └── address_model.dart
35 | │ │ │ │ └── repositories/
36 | │ │ │ │ └── address_repositories.dart
37 | │ │ │ ├── domain/
38 | │ │ │ │ ├── entities/
39 | │ │ │ │ │ └── address_entities.dart
40 | │ │ │ │ ├── repositories/
41 | │ │ │ │ │ └── address_repositories.dart
42 | │ │ │ │ └── usecases/
43 | │ │ │ │ └── address_usecases.dart
44 | │ │ │ └── presentation/
45 | │ │ │ ├── bloc/
46 | │ │ │ │ ├── address_bloc.dart
47 | │ │ │ │ ├── address_event.dart
48 | │ │ │ │ └── address_state.dart
49 | │ │ │ ├── pages/
50 | │ │ │ │ └── address_page.dart
51 | │ │ │ └── widgets/
52 | │ │ │ └── address_widgets.dart
53 | │ │ ├── authentication/
54 | │ │ │ └── (...)
55 | │ │ ├── cart/
56 | │ │ │ └── (...)
57 | │ │ ├── checkout/
58 | │ │ │ └── (...)
59 | │ │ ├── orders/
60 | │ │ │ └── (...)
61 | │ │ └── products/
62 | │ │ └── (...)
63 | │ ├── localization/
64 | │ │ ├── app_bn.arb
65 | │ │ ├── app_en.arb
66 | │ │ └── localization.dart
67 | │ ├── routing/
68 | │ │ └── routing.dart
69 | │ └── utils/
70 | │ └── utils.dart
71 | └── main.dart
72 | ```
73 |
74 | You might notice that some files are just dummy (like api.dart, model.dart).
75 | They are placed there just for git to take the folder structure into consideration.
76 | Leaving those folders empty won't let git to take them into consideration. Since this is mostly a startup project, I was thinking of offering you the standard folder structure from the start. Of course, this may change multiple times, improving every time more and more.
77 |
78 | ## Why this design pattern?
79 |
80 | 
81 |
82 | This architecture is made of four distinct layers, each containing the components that our app needs: 
127 |
128 | `Feature-first is not about the UI!`
129 |
130 | Feature is not about what the user sees, but what the user does:
131 |
132 | ```
133 | ➮ authenticate
134 | ➮ manage the shopping cart
135 | ➮ checkout
136 | ➮ view all past orders
137 | ➮ leave a review
138 | ```
139 |
140 | In other words, a feature is a functional requirement that helps the user complete a given task.
141 |
142 | And using some hints from domain-driven design, I decided to organize the project structure around the domain layer.
143 |
144 | Once I figured that out, everything fell into place. And I ended up with seven functional areas that you can see on the right.
145 |
146 | Note that with this approach is still possible for code inside a given feature to depend on code from a different feature. For example:
147 |
148 | ```
149 | ➮ the product page shows a list of reviews
150 | ➮ the orders page shows some product information
151 | ➮ the checkout flow requires the user to authenticate first
152 | ```
153 |
154 | But we end up with far fewer files that are shared across all features, and the entire structure is much more balanced.
155 |
156 | ## How to do `feature-first`, the right way?
157 |
158 | In summary, the feature-first approach lets us structure our project around the functional requirements of our app.
159 |
160 | So here's how to use this correctly in your own apps:
161 |
162 | ☞ start from the domain layer and identify the model classes and business logic for manipulating them