🏗️ Flutter Architect CLI #

A powerful CLI tool to scaffold Flutter projects with multiple architecture patterns automatically.
Choose from Clean Architecture, MVC, MVVM, or MVP patterns with interactive selection and get a production-ready project structure instantly.

🚀 Features #

• 🧱 4 Architecture Patterns: Clean Architecture, MVC, MVVM, and MVP
• ⚙️ Interactive Selection: Choose your preferred pattern during project creation
• 🧩 Feature-First Organization: Modular and scalable code structure
• 🧰 Production-Ready: Pre-configured with best practices and utilities
• 🔐 Complete Examples: Auth feature implementation for each pattern
• 🧭 Dependency Injection: Ready-to-use service locator setup
• 🔄 State Management: BLoC and ViewModel patterns included
• ⚡ Zero Configuration: Start coding immediately with no setup required
• 🧠 Best Practices: Industry-standard patterns and conventions

🧩 Installation #

From pub.dev (Recommended) #

dart pub global activate flutter_architect_cli

From GitHub (Latest Development) #

dart pub global activate --source git https://github.com/Nader15/flutter_architect_cli.git

⚡ Quick Start #

Create a new Flutter project with architecture scaffolding:

flutter_architect create my_app

You'll be prompted to select an architecture pattern:

🚀 Creating Flutter project: my_app

Please select an architecture pattern:

1. Clean Architecture Pattern
2. MVC Pattern
3. MVVM Pattern
4. MVP Pattern

Enter your choice (1-4): 1

The CLI will scaffold your complete project structure — start developing immediately!

🏗️ Architecture Patterns #

1. Clean Architecture Pattern ✅ #

Best for: Enterprise apps, complex business logic, long-term projects

📁 Structure:

lib/
├── core/
│   ├── constants/
│   ├── error/
│   ├── network/
│   ├── utils/
│   ├── theme/
│   └── di/
├── features/
│   ├── auth/
│   │   ├── presentation/
│   │   ├── domain/
│   │   └── data/
│   └── [other features]/
└── shared/

🌟 Key Benefits

• Highly testable and maintainable
• Clear separation of concerns
• Easy to scale and add new features
• Industry standard for large projects

🧰 Technologies

• GetIt for dependency injection
• BLoC for state management
• Dartz for functional programming
• Repository pattern

2. MVC Pattern ✅ #

Best for: Small to medium apps, rapid development, simpler projects

📁 Structure:

lib/
├── models/
├── views/
├── controllers/
├── services/
└── utils/

🌟 Key Benefits

• Simple and straightforward
• Fast development cycle
• Easy to understand for beginners
• Lightweight architecture

🧰 Technologies

• Provider for state management
• Model classes with JSON serialization
• Service layer for business logic

3. MVVM Pattern ✅ #

Best for: Medium to large apps, data-binding focus, modern Flutter apps

📁 Structure:

lib/
├── core/
├── data/
├── domain/
├── features/
│   ├── presentation/
│   │   ├── views/
│   │   └── viewmodels/
│   ├── data/
│   └── domain/
└── shared/

🌟 Key Benefits

• Strong data binding
• Clear separation of UI and logic
• Easier unit testing
• Suitable for complex UIs

🧰 Technologies

• Provider/ChangeNotifier for state management
• Repository pattern
• ViewModel for business logic

4. MVP Pattern ✅ #

Best for: Apps requiring testability, presenter-centric logic, contract-based development

📁 Structure:

lib/
├── core/
├── features/
│   ├── [feature]/
│   │   ├── model/
│   │   ├── view/
│   │   ├── presenter/
│   │   └── view_interface/
└── shared/

🌟 Key Benefits

• Excellent testability
• Clear contracts between layers
• Presenter-focused business logic
• Easy to refactor UI without affecting logic

🧰 Technologies

• Presenter pattern
• View interfaces/contracts
• Repository pattern

🧠 Command Reference #

flutter_architect create <project_name>

Arguments:

• <project_name> – Name of the Flutter project (default: my_flutter_app)

Interactive Selection:

• 1️⃣ Clean Architecture – Recommended for enterprise applications
• 2️⃣ MVC – Best for rapid development
• 3️⃣ MVVM – Ideal for complex data-driven UIs
• 4️⃣ MVP – Perfect for highly testable code

📊 Project Structure Comparison #

🧩 Generated Files Overview #

Core Components (All Patterns) #

• Constants
• Utilities
• Theme
• Error Handling
• Network
• Dependency Injection

Feature Components (Pattern Specific) #

• ✅ User authentication
• 📦 Data models
• 🧱 Repository pattern
• 🔄 State management
• 🖥️ UI layers

🧰 Getting Started After Generation #

1. Open the project

   cd my_app
   flutter pub get
   

2. Review the structure
3. Replace placeholders
   • Update API endpoints in constants
   • Implement actual API calls
   • Add your business logic
4. Add dependencies
5. Start coding! 🎯

💉 Dependency Injection Setup #

🧠 Best Practices Included #

• ✅ Separation of concerns
• ✅ Error handling patterns
• ✅ Validation utilities
• ✅ Theme & constants management
• ✅ Network error handling
• ✅ Repository pattern implementation

⚠️ Troubleshooting #

Project not created

• Ensure you have write permissions
• Check project name characters

Missing dependencies

flutter pub get

Build errors

• Replace placeholder implementations.

🤝 Contributing #

Contributions are welcome! Submit issues and pull requests.

📄 License #

MIT License – see LICENSE

💬 Support #

• GitHub: flutter_architect_cli
• pub.dev: flutter_architect_cli

🎉 Happy Architecting with Flutter! 🚀 #