🏗️ Flutter Clean Architecture Template

A production-ready Flutter starter — feature-first Clean Architecture, scalable by design.

Quick Start · Architecture · Commands · New Feature

---

✨ Highlights

	Feature
🧱	Feature-first Clean Architecture — presentation → domain ← data
🎯	Cubit + GetIt — predictable state & dependency injection
🔀	Either<Failure, T> — typed errors via dartz + safeCall
🌐	Dio + Hive — network with local cache fallback
🧭	go_router — shell navigation with bottom tabs
🌍	Flavors + i18n — dev / prod + easy_localization
⚡	Mason brick — scaffold a full feature in one command

Reference feature: home — pagination, cache fallback, cancelable cubit.

---

🏛️ Architecture

┌──────────────────────────────────────────────────────┐
│  presentation   Pages · Widgets · Cubit · State      │
├──────────────────────────────────────────────────────┤
│  domain         Entities · Repository · UseCases     │
├──────────────────────────────────────────────────────┤
│  data           Models · DataSources · RepoImpl      │
└──────────────────────────────────────────────────────┘
         ▲                              │
         │  domain is pure Dart         │  implements contracts
         └──────────────────────────────┘

Data flow: UI → Cubit → UseCase → Repository → DataSource → Either<Failure, T> → emit State

lib/
├── main_dev.dart / main_prod.dart     # Flavor entry points
├── config/          # env · routing · theme
├── core/            # DI · network · errors · storage
├── features/        # home · cart · profile · theme
│   └── <feature>/
│       ├── data/ · domain/ · presentation/
│       └── <feature>_injection.dart
└── shared/          # use cases · widgets · navigation

---

🚀 Quick Start

# 1. Install
flutter pub get

# 2. Configure env (edit lib/config/env/.env)
API_KEY=your_api_key
BASE_URL=https://your-api.example.com

# 3. Generate code
dart run build_runner build --delete-conflicting-outputs

# 4. Run
flutter run --flavor dev -t lib/main_dev.dart

Android: --flavor is required (dev / prod in build.gradle.kts).

---

📟 Commands

Run & Build

# Dev
flutter run --flavor dev -t lib/main_dev.dart

# Prod
flutter run --flavor prod -t lib/main_prod.dart

# Release
flutter build apk --flavor prod -t lib/main_prod.dart
flutter build appbundle --flavor prod -t lib/main_prod.dart

Code Generation

# Envied + Hive (after editing .env or Hive models)
dart run build_runner build --delete-conflicting-outputs

# Translation keys
dart run easy_localization:generate --source-dir ./assets/translations -f keys -o locale_keys.g.dart

New Feature (Mason)

dart pub global activate mason_cli
mason get
mason make feature --feature_name order --entity_name Order

Tests

flutter test

---

➕ Add a Feature

After mason make feature ..., wire it up in 3 steps:

Step	File	Action
1️⃣	lib/core/constants/api_endpoints.dart	Add API endpoint
2️⃣	lib/core/di/injection_container.dart	Call initYourFeature() in initCore()
3️⃣	lib/config/routing/app_router.dart	Register GoRoute

Pattern checklist (follow home):

• UseCase<T, Param> returns Either<Failure, T>
• RepositoryImpl wraps calls with safeCall
• Cubit folds Either → Loading / Loaded / Error
• Page uses BlocProvider(create: (_) => sl<YourCubit>())

---

📦 Tech Stack

Layer	Packages
Architecture	dartz · equatable · get_it
State	flutter_bloc
Network	dio · internet_connection_checker_plus
Routing	go_router
Storage	hive · shared_preferences · flutter_secure_storage
Config	flutter_flavor · envied
UI / i18n	flutter_screenutil · shimmer · easy_localization

---

Built with ❤️ for scalable Flutter apps

Report Bug · Request Feature