A production-ready, highly scalable Flutter template designed for modern application development. This project implements strictly typed Clean Architecture with Riverpod for state management and dependency injection.

• Strict Clean Architecture: Clear separation of Domain, Data, and Presentation layers.
• Functional Error Handling: Uses fpdart for type-safe error handling (Either<Failure, T>).
• Riverpod 2.0: Modern provider patterns with Notifier and AsyncNotifier.
• Framework Independence: Domain and Data layers are testable without Flutter dependencies.

• Feature Generator: Create complete features in seconds (./generate_feature.sh).
• Strict Linting: Zero-tolerance analysis options for code quality.
• CI/CD Ready: GitHub Actions workflows for automated testing and analysis.
• Type Safety: Full null-safety and strict typing throughout.

• Real-Time Features: WebSocket integration example (Chat).
• Complex Forms: Advanced form handling with validation (Survey).
• Offline First: Local storage strategies with Hive/SharedPreferences.
• Secure Storage: Encrypted credential storage.
• Biometric Auth: FaceID and Fingerprint integration.
• Localization: Built-in multi-language support.

• Architecture Guide: Deep dive into the project structure.
• Coding Standards: Rules and patterns used in this project.
• Feature Guide: Documentation for core features.
• CLI Tools: How to use the generator scripts.

• Flutter SDK (3.7+)
• Dart SDK (3.0+)

# Clone the repository
git clone https://github.com/ssoad/flutter_riverpod_clean_architecture.git

# Install dependencies
flutter pub get

# Generate code (Freezed, Riverpod, etc.)
dart run build_runner build --delete-conflicting-outputs

# Development
flutter run

# Production Build
flutter build apk --release

Don't write boilerplate manually! Use the included generator script:

# Generate a full feature with UI, Domain, and Data layers
./generate_feature.sh --name my_awesome_feature

This creates:

• domain/entities/, repositories/, usecases/
• data/models/, datasources/, repositories/
• presentation/providers/, screens/, widgets/
• providers/ (DI configuration)
• Unit tests for all layers

Start your project with the right identity! Use our renaming utility:

./rename_app.sh --app-name "My Super App" --package-name com.company.superapp

This updates:

• Android: AndroidManifest.xml, build.gradle, Kotlin files
• iOS: Info.plist, Project files
• macOS, Windows, Linux Build files
• Dart package name & imports

Generate native app icons for all platforms in one command:

1. Place your icon file (1024x1024) at assets/icon/app_icon.png.
2. Run the generator script:

./generate_icons.sh

This updates:

• Android mipmap resources
• iOS Assets.xcassets
• Web manifest.json and icons
• Windows/macOS/Linux icon files

lib/
├── core/                       # Shared kernel (Errors, Network, Utils)
├── features/                   # Feature modules
│   ├── auth/                   # Authentication Feature
│   ├── chat/                   # WebSocket Chat Feature
│   ├── survey/                 # Complex Form Feature
│   └── ...
├── main.dart                   # Entry point
└── ...

Each feature is a self-contained module:

feature_name/
├── domain/                     # 1. Innermost Layer (Pure Dart)
│   ├── entities/               # Business objects (Equatable)
│   ├── repositories/           # Abstract interfaces
│   └── usecases/               # Business logic units
├── data/                       # 2. Outer Layer (Implementation)
│   ├── datasources/            # API/DB clients
│   ├── models/                 # JSON parsing & Adapters
│   └── repositories/           # Repository implementations
├── presentation/               # 3. UI Layer (Flutter)
│   ├── providers/              # UI State Management (Notifiers)
│   ├── screens/                # Widget pages
│   └── widgets/                # Reusable components
└── providers/                  # 4. DI Layer (Riverpod)
    └── feature_providers.dart  # Data layer dependency injection

We use a comprehensive testing strategy:

• Unit Tests: For Use Cases, Repositories, and Data Sources.
• Widget Tests: For reusable UI components.
• Golden Tests: For visual regression testing of screens.

# Run all tests
flutter test

# Update Golden files
flutter test --update-goldens

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.