flutter_architect_cli 1.1.1

A CLI tool to scaffold Flutter projects with multiple architecture patterns (Clean Architecture, MVC, MVVM, MVP)

🏗️ Flutter Architect CLI

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

🚀 NEW: Enhanced with advanced Template System, 80% code reduction, and optimized performance!

---

🚀 Features

• 🧱 3 Architecture Patterns: Clean Architecture, MVC, MVVM
• 🔄 4 State Management Options: BLoC (Cubit), Provider, Riverpod, GetX
• ⚙️ 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
• ⚡ Zero Configuration: Start coding immediately with no setup required
• 🧠 Best Practices: Industry-standard patterns and conventions
• 🎯 Advanced Template System: Dynamic code generation with 80% less duplication
• 🚀 Optimized Performance: Faster project generation and better maintainability
• 🔧 Modular Architecture: Clean separation of concerns and extensible design
• 🏢 Custom Package Names: Interactive organization/package name input during project creation
• ✅ Multi-Platform Support: Complete Flutter projects with all platform folders (Android, iOS, Web, Windows, macOS, Linux)

---

🧩 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 and state management:

🚀 Creating Flutter project: my_app

🏢 Organization Details
───────────────────────
Enter your organization/package name (e.g., com.mycompany)
This will be used for:
  • Android package name (e.g., com.mycompany.my_app)
  • iOS bundle identifier (e.g., com.mycompany.myApp)
  • Dart package imports

Organization (default: com.example): com.mycompany
✓ Organization set to: com.mycompany

📁 Please select an architecture pattern:

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

Enter your choice (1-3): 1

🎛️  Please select a state management solution:

1. BLoC (Cubit)
2. Provider
3. Riverpod
4. GetX

Enter your choice (1-4): 1

🎯 Selected Architecture: Clean Architecture Pattern
🎯 Selected State Management: BLoC (Cubit)
🏢 Organization: com.mycompany

✅ Clean Architecture project created successfully!

The CLI will scaffold your complete project structure with the selected architecture and state management — 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
• Multiple state management options (BLoC Cubit, Provider, Riverpod, GetX)
• Repository pattern
• Advanced template system for code generation

---

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

• Multiple state management options (BLoC Cubit, Provider, Riverpod, GetX)
• Model classes with JSON serialization
• Service layer for business logic
• Template-based code generation

---

3. MVVM Pattern ✅

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

📁 Structure:

lib/
├── main.dart
├── core/
│   ├── constants/
│   ├── utils/
│   ├── theme/
│   └── services/
├── data/
│   ├── models/
│   ├── repositories/
│   ├── datasources/
│   └── api/
├── domain/
│   ├── entities/
│   ├── repositories/
│   └── usecases/
└── presentation/
    ├── views/
    ├── viewmodels/
    ├── widgets/
    └── state/

🌟 Key Benefits

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

🧰 Technologies

• Multiple state management options (BLoC Cubit, Provider, Riverpod, GetX)
• Repository pattern
• ViewModel for business logic
• Advanced template system

---

🧠 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

State Management Options:

• 1️⃣ BLoC (Cubit) – Reactive state management
• 2️⃣ Provider – Simple state management
• 3️⃣ Riverpod – Modern state management
• 4️⃣ GetX – All-in-one solution

---

📊 Project Structure Comparison

Feature	Clean Arch	MVC	MVVM
Complexity	High	Low	Medium
Testability	Excellent	Good	Good
Scalability	Excellent	Good	Very Good
Learning Curve	Steep	Easy	Medium
Best For	Large Projects	Quick Prototypes	Data-Heavy Apps
File Count	High	Low	Medium

---

🧩 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

Pattern	Dependency Injection
Clean Architecture	GetIt
MVC	ServiceLocator
MVVM	Simple DI container

---

🧠 Best Practices Included

• ✅ Separation of concerns
• ✅ Error handling patterns
• ✅ Validation utilities
• ✅ Theme & constants management
• ✅ Network error handling
• ✅ Repository pattern implementation
• ✅ Template-based code generation
• ✅ Modular architecture design
• ✅ Consistent code structure across patterns
• ✅ Optimized performance and maintainability

---

🚀 Recent Improvements

Template System & Code Optimization

• import paths: Update import paths and restructure project files for improved organization
• MVVM Improvements: Update and Improve project structure for MVVM pattern
• 80% Code Reduction: Eliminated massive code duplication across architecture patterns
• Advanced Template Engine: Dynamic code generation with variable substitution
• Modular Design: Clean separation between template logic and business logic
• Performance Boost: Faster project generation and better IDE performance
• Consistent Structure: Standardized folder structures and naming conventions

Enhanced State Management

• 4 State Management Options: Full support for BLoC, Provider, Riverpod, GetX
• Pattern-Specific Integration: Each architecture pattern optimized for different state management solutions
• Template-Based Generation: State management files generated from reusable templates

Architecture Pattern Refactoring

• New Base Class System: PatternBase provides common functionality across all patterns
• Reduced Complexity: Each pattern file reduced from 1000+ lines to ~150-200 lines
• Better Maintainability: Single source of truth for templates and common functionality
• Extensibility: Easy to add new patterns and state management solutions

---

⚠️ 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! 🚀