Getting Started with Flutter Riverpod Clean Architecture

This guide will help you get up and running with the Flutter Riverpod Clean Architecture template.

Prerequisites

• Flutter SDK (version 3.7.0 or higher)
• Dart SDK (version 3.0.0 or higher)
• An IDE with Flutter support (VS Code, Android Studio, or IntelliJ)

Installation Options

Option 1: Clone the Repository

git clone https://github.com/ssoad/flutter_riverpod_clean_architecture.git
cd flutter_riverpod_clean_architecture
flutter pub get

Option 2: Use as Template

1. Go to the GitHub repository
2. Click on "Use this template" button
3. Follow the GitHub instructions to create your repository
4. Clone your new repository locally

Option 3: Create a New Project Based on the Template

flutter create --template https://github.com/ssoad/flutter_riverpod_clean_architecture my_new_app
cd my_new_app
flutter pub get

Running the Project

Once you have installed the project, you can run it using:

flutter run

This will launch the application on your connected device or emulator.

Next Steps

• Explore the project structure to understand the architecture
• Check out the examples in lib/examples folder
• Read the Architecture Guide to learn more about the project's architecture