A MVVM architecture and project structure approaches to developing Flutter apps

Last update: Mar 18, 2022

Overview

Flutter Architecture Blueprints

Flutter Architecture Blueprints is a project that introduces MVVM architecture and project structure approaches to developing Flutter apps.

Documentation

Installation

asdf
- Dart 2.14.4
- Flutter 2.5.3
npm (for git hooks)

Environment

iOS

iOS 13+

Android

Android 5.1+
- minSdkVersion 22
targetSdkVersion 30

App architecture

Base on MVVM + Repository

Code Style

flutter_lints

Assets, Fonts

If added some assets or fonts

Use FlutterGen

Models

If added some models for api results

Use Freezed

Localizations

If added some localizations (i.g. edited *.arb)

Use Official Flutter localization package

Git Commit message style

Semantic Commit Messages

Code collections

Project settings

Working status	Category	Description	Codes
✅	Dart	Dart version	pubspec.yaml
✅	asdf	asdf	.tool-versions
✅	Dart	Switching between Development and Production environment	constants.dart, runConfigurations, Makefile
✅	Dart	Lint / Analyze	analysis_options.yaml
✅	Android	Kotlin version	build.gradle
✅	Android	Apk attributes	build.gradle (compileSdkVersion, applicationId, minSdkVersion, targetSdkVersion)
✅	Android	Switching between Development and Production environment	build.gradle, Flavor dirs, signingConfigs
✅	iOS	Xcode version	compatibilityVersion
✅	iOS	Podfile	Podfile
✅	iOS	Switching between Development and Production environment	xcconfig, Podfile
✅	Firebase	[Android] Switching between Development and Production google-service.json using flavors	development and production
✅	Firebase	[iOS] Switching between Development and Production GoogleService-Info.plist using run script	copy_google_service.sh, development and production
✅	Firebase Auth	SignIn, SignOut	auth_data_source_impl.dart
✅	Firebase Crashlytics	Crash Reports	main.dart
✅	Firebase Performance	Network monitoring with dio_firebase_performance	app_dio.dart

Architecture

Working status	Category	Description	Codes
✅	Base	Using Riverpod + Hooks + ChangeNotifier + MVVM	news_page.dart, news_view_model.dart, news_repository.dart, news_data_source.dart
✅	Networking	Using dio and Retofit	app_dio.dart, news_data_source.dart
✅	Data	Using Freezed	model classes
✅	Constants	Define constants and route names	constants.dart
✅	Localization	Switching between two languages with Intl package	*.arb
✅	Error handling	Using Result pattern - A value that represents either a success or a failure, including an associated value in each case.	result.dart, news_repository_impl.dart, home_page.dart

UI

Working status	Category	Description	Codes
✅	Theme	Staticly Switch between light and dark themes	app_theme.dart
✅	Font	Using Google font	app_theme.dart
✅	Transition	Simple animation between screens using Hero	article_item.dart, detail_page.dart

Testing

Working status	Category	Description	Codes
✅	API(Repositories)	Using mocktail	view_mode_test.dart
✅️	UI	Using mocktail	widget_test.dart
✅	Coverage reports	Send the report to Codecov on CI	codecov.yml, codecov.sh, flutte-ci.yml

CI

Working status	Category	Description	Codes
✅	Git	Git hooks for format and analyze	package.json, Makefile
✅	Git	.gitignore settings	.gitignore
✅	Build	Using Codemagic	codemagic.yaml
✅	Build	Using Bitrise	bitrise.yml
✅	Build	Using Github Actions	.github/workflows/flutter-ci.yml

Getting Started

Setup

$ make setup
$ export PATH="$PATH":"$HOME/.pub-cache/bin" # Add your run-commands (.zshrc, .bashrc, etc)
$ make dependencies
$ make build-runner

How to add assets(images..)

Add assets
Run FlutterGen

How to add localizations

Edit *.arb files.
Run generate the flutter pub get

Make .apk and .ipa file

Android

$ make build-android-dev
$ make build-android-prd

iOS

$ make build-ios-dev
$ make build-ios-prd

Run app

$ make run-dev
$ make run-prd

Special Thanks.

News API

Contributors

lcdsmao

A project to learn about Clean Architecture

Star Wars - Clean Architecture I'm developing this App aiming to learn about Clean Architecture and Dart/Flutter It's a very simple app which the user

Feb 1, 2022

Self Host Group Chat App (firebase + clean architecture) is full functional group chat where you can create new groups and update profile and communicate in different groups easily. there 2 auth firebase method [Google & Email Password]

Self Host Group Chat App (firebase + clean architecture) Show some and star the repo to support the project Screenshots Packages we are using: flutter

Jan 8, 2023

Flutter travel app with clean architecture and firebase

atlas A new Flutter project. Getting Started This project is a starting point for a Flutter application. A few resources to get you started if this is

Jan 25, 2022

Number trivia Android and ios application using flutter clean architecture

demo_project A new Flutter project. Getting Started This project is a starting point for a Flutter application. A few resources to get you started if

Jun 9, 2022

Real-world movie database mobile application with the Flutter SDK and DDD clean architecture.

Moving Pictures Moving Pictures is a mobile application built with the Flutter SDK for Android and iOS. It’s an application that gets the information

Jan 7, 2023

Flutter App to save notes secure, using cryptography, clean architecture and some design patterns.

notes A new Flutter project. Getting Started This project is a starting point for a Flutter application. A few resources to get you started if this is

Mar 28, 2022

A study about clean architecture and TDD(Test Driven Development) in Flutter.

coin_checker A study about clean architecture and TDD(Test Driven Development) in Flutter. Getting Started This project is a starting point for a Flut

Jan 25, 2022

Example repository of handling permissions in Flutter using BLoC and Clean Architecture.

flutter_permission_handling A new Flutter project. Getting Started This project is a starting point for a Flutter application. A few resources to get

Dec 28, 2021

Cross-platform GitHub client in Flutter and BLoC clean architecture

FlutterHub Cross-platform GitHub client in Flutter and BLoC clean architecture. SwiftHub - Swift version is available Try Web version Get Started To g

Nov 12, 2022