flutter_clean_arch_template

New Flutter project with clean archetechture

Getting Started

1. Get the template

   Create your project using this repo by either:

   • On Github, click the "Use this template" button, which will allow you to create your project using this repo as your baseline, or
   • Clone this repo to your local machine

2. Install dependencies

   Run flutter pub get to fetch dependencies.

   if you want to run on ubuntu linux build Run

   sudo apt install libsecret-1-dev libsecret-tools libsecret-1-0

   sudo apt install xapp-sn-watcher libxapp-gtk3-module

3. Application Bundle Name

   Change name on pubspec.yaml

   Now to change your app's package name/bundle identifier in both Android and iOS manifests, run dart run change_app_package_name:main <com.new.package.name>.

   • This step uses change_app_package_name, go give the package some love.

   for macos find com.example.flutterCleanArchTemplate and replace with <package_name>

4. Application Name Next, you'll need to change your app's user-readable label - the CFBundleName and/or CFBundleDisplayName within the Info.plist (for iOS) and android:label field in your application node in AndroidManifest.xml (for Android).

   Next, Serach flutter_clean_arch_template and replace with your <package_name>

   I'm afraid this step is manual; it would be cool if change_app_package_name could do this for you.

   NOTE: You'll also need to change your package name and description within pubspec.yaml

5. App Icons

   Then we'll auto-generate your app launcher icons using the flutter_launcher_icons package.

   • Copy the image you want to make your launcher icons out of to assets/icon/icon.png.
   • Now run dart run flutter_launcher_icons. This command will auto-generate Android and iOS launcher icons from the PNG file for the different DPIs and place them in their respective resource directories.

   NOTE: Check the package documentation for more configuration options on generating launcher icons updating your pubspec. yaml accordingly. For example, you may want different icons for different platforms since Android allows you to use a transparent icon and iOS doesn't. However, the default configuration included in this template will be sufficient in most cases.

6. Splash screen

   We'll then generate native splash screens for both of our platforms which your app will display before loading is complete and for this, we'll use flutter_native_splash.

   • Copy the image you want to be displayed at the center of your splash screen to assets/splash/splash.png.
   • To change the background color of your splash screen, go to your pubspec.yaml under flutter_native_splash -> color and put your preferred color code. The default is white.
   • Finally, run dart run flutter_native_splash:create to generate your resources from the splash image and update your manifest files.

7. Environment variables

   We'll make use of envied package to load app configuration from .env files. This will allow us to easily switch between different app configurations when running the app under different environments like production, staging, or debug modes.

   All .env files can be placed in the root directory of your project. The To set up a new environment, create a new file with a .env extension (e.g. .env or debug.env or staging.env), then copy the contents of .env-sample and populate it as needed.

   The lib/env.dart file imports the environment variables into the app. Look at the documentation to understand how to use the envied package.

   To obfuscate and hide sensitive ENV variable use the obfuscate attribute like so: @EnviedField(obfuscate: true).

   NOTE: All .env files (and envied's env.g.dart file) are .gitignored by default since they may contain sensitive information such as paths, keys, and such To specify new env keys add them to the .env.sample file, which will be copied by other devs and the corresponding configuration will be provided

8. Firebase Reporting

   In this step, we are going to integrate different Firebase Reporting Tools into your app, including Firebase Analytics, Firebase Performance, and Crashlytics.

   • Create your Firebase project on the Firebase Console
   • Log into Firebase using your Google account by running the following command:

   firebase login

   • Install the FlutterFire CLI by running the following command from any directory:

   dart pub global activate flutterfire_cli

   • Use the FlutterFire CLI to configure your Flutter apps to connect to Firebase.

   flutterfire configure

   NOTES:

   • All the Firebase Services we're using in this project are free of charge - at least at the time of writing - so they will not attract any charges.
   • With this step, we'll also have integrated Firebase Performance Monitoring into your HTTP Client using dio_firebase_performance which is a Dio Interceptor that will measure the performance of all your HTTP calls and report the stats to Firebase.

9. Generate custom lint

   • Run dart run custom_lint

10. Start Development

• Run flutter pub get
• Run dart run build_runner build
• Run dart run build_runner watch or dart run build_runner watch --delete-conflicting-outputs
• Run flutter run

OR

• Run make watch and
• Run make run_debug

11. Deploying

Before releasing your Android app, make sure to sign it by:

keytool -genkey -v -keystore ~/key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias key

Generate a Keystore file if you don't already have one. If you have one, ignore this step and go to the next.

Go to android/key.properties and include your Keystore path, alias, and password.

• Running flutter build defaults to a release build.

flutter build appbundle

OR

make build_bundle

To generate SHA-1 for Flutter

cd android
./gradlew signingReport

Feature Layer architecture

Layer	Contains
Data	Repository, DTO, Data Source
Domain	Model
Application	Service
Presentation	Widget, Provider (State), Controller

flowchart TD
    VM[View Model]-->U(Use Case)
    MP[Mapper]-->MD[Model]
    subgraph Presentation
    V[View]-->VM(View Model)
    W[Widgets]-->V[View]
    end
    subgraph Domain
    UI(Use Case Impl)-->U[Use Case]
    U[Use Case]-->MD[Model]-->R[Repository]
    UI(Use Case Impl)-->R[Repository]
    end
    subgraph Data
    RI[Repository Impl]-->MP[Mapper]
    RI[Repository Impl]-->R[Repository]
    E(Entity)-->D[Database]
    DI[Database Impl]-->D[Database]
    RI[Repository Impl]-->E(Entity)
    end

Loading

Removing unwanted packages

If a package is not listed, then removing it from pubspec.yaml as well as all imports and uses should be enough. This is required for removing every packages, the following instructions are an addition to that.

Flutter Lints

Delete the analysis_options.yaml file. As an alternative you can modify the rules in this file or use a different package like Lint.

Easy Localization

Remove the assets/translations folder. Go to ios/Runner/Info.plist and remove the following code:

<key>CFBundleLocalizations</key>
<array>
  <string>en</string>
  <string>bn</string>
</array>

Url Launcher

For iOS go to ios/Runner/Info.plist and remove the following code:

<key>LSApplicationQueriesSchemes</key>
<array>
  <string>https</string>
  <string>http</string>
</array>

For Android you can take a look at this Stackoverflow issue for more information. Go to android/app/src/AndroidManifest.xml and add the following code:

<manifest [...]

    <application>
        [...]
    </application
    
    <queries>
        <intent>
            <action android:name="android.intent.action.VIEW" />
            <data android:scheme="https" />
        </intent>
    </queries>

</manifest>

Define and use scripts from your pubspec.yaml file

1. Install this package.

dart pub global activate rps

2. Define script inside the pubspec.yaml

name: my_great_app
version: 1.0.0

scripts:
   # run is a default script. To use it, simply type
   # in the command line: "rps" - that's all!
   run: "flutter run -t lib/main_development.dart --flavor development"
      # you can define more commands like this: "rps gen"
      gen: "flutter pub run build_runner watch --delete-conflicting-outputs"
      # and even nest them!
      build:
      android:
      # rps build android apk
      apk: "flutter build --release apk --flavor production"
      # rps build android appbundle
      appbundle: "flutter build --release appbundle --flavor production"
      # and so on...

# the rest of your pubspec file...
dependencies:
   path: ^1.7.0

3. Use your custom command.

Like this gen command that we defined in the previous step:

rps gen

instead of

flutter pub run build_runner watch --delete-conflicting-outputs

Packages used

This repository uses the following pub packages:

Package	Version	Usage
Flutter Riverpod	^2.6.1	State management*
Flutter Lints	^5.0.0	Stricter linting rules
Path Provider	^2.1.4	Get the save path for Hive
Flutter Displaymode	^0.6.0	Support high refresh rate displays
Easy Localization	^3.0.7	Makes localization easy
Url Launcher	^6.2.4	Open urls in Browser

* Recommended to keep regardless of your project

• change_app_package_name - Changes app package name with a single command. It makes the process very easy and fast.
• dio - The best HTTP Client for Flutter IMO. Reusable interceptors, amirite?
• envied - Load configuration from a .env file.
• firebase_analytics - Flutter plugin for Google Analytics for Firebase, an app measurement solution that provides insight on app usage and user engagement on Android and iOS.
• firebase_crashlytics - Flutter plugin for Firebase Crashlytics. It reports uncaught errors to the Firebase console.
• firebase_performance - Flutter plugin for Google Performance Monitoring for Firebase, an app measurement solution that monitors traces and HTTP/S network requests on Android and iOS.
• firebase_performance_dio - Dio's Interceptor implementation that sends HTTP request metric data to Firebase.
• flutter_launcher_icons - A command-line tool that simplifies the task of updating your Flutter app's launcher icon.
• flutter_native_splash - Automatically generates native code for adding splash screens in Android and iOS. Customize with a specific platform, background color, and splash image.
• go_router - This package builds on top of the Flutter framework's Router API and provides convenient URL-based APIs to navigate between different screens.
• pretty_dio_logger - Dio interceptor that prettily prints to console HTTP requests and responses going through Dio