Flutter Template CLI 🚀

Instantly set up a complete Flutter app structure with pre-built architecture and essential packages.

✨ Features

• 📁 Complete folder structure (core, features, models, services, widgets)
• 🎨 Pre-configured theme and styling
• 📦 Auto-installs required packages (GetX, Dio, Flutter Portal, Get Storage)
• 🏗️ Clean architecture ready to use
• ⚡ Zero configuration needed - just run and code!

📦 What Gets Installed

The template automatically includes:

• GetX (^4.7.2) - State management & routing
• Dio (^5.9.0) - HTTP client for API calls
• Flutter Portal (^1.1.4) - Advanced overlay widgets
• Get Storage (^2.1.1) - Local storage solution

🚀 Installation

dart pub global activate get_clean

📖 Usage

1. Create a new Flutter project:

flutter create my_awesome_app
cd my_awesome_app

2. Run the template installer (fully automated):

get_clean

3. Start coding! Everything is set up:

flutter run

That's it! The CLI will:

• ✅ Copy the complete lib folder structure
• ✅ Add all required dependencies to pubspec.yaml
• ✅ Run flutter pub get automatically
• ✅ Everything ready to use!

📂 Folder Structure

my_awesome_app/
├── lib/
│   ├── main.dart
│   ├── app/
│   │   ├── app_binding.dart
│   │   ├── app_controller.dart
│   │   └── app_view.dart
│   ├── core/
│   │   ├── constants/
│   │   │   └── app_constants.dart
│   │   ├── errors/
│   │   │   ├── exceptions.dart
│   │   │   └── failures.dart
│   │   ├── routes/
│   │   │   └── app_pages.dart
│   │   ├── theme/
│   │   │   ├── app_colors.dart
│   │   │   ├── app_theme.dart
│   │   │   └── app_typography.dart
│   │   └── utils/
│   │       ├── app_utils.dart
│   │       └── helpers.dart
│   ├── data/
│   │   ├── datasources/
│   │   │   ├── local_datasource.dart
│   │   │   └── remote_datasource.dart
│   │   ├── models/
│   │   │   └── base_model.dart
│   │   └── repositories/
│   │       └── base_repository_impl.dart
│   ├── domain/
│   │   ├── entities/
│   │   │   └── base_entity.dart
│   │   ├── repositories/
│   │   │   └── base_repository.dart
│   │   └── usecases/
│   │       └── base_usecase.dart
│   ├── features/
│   │   ├── auth/
│   │   │   ├── bindings/
│   │   │   │   └── auth_binding.dart
│   │   │   ├── controllers/
│   │   │   │   └── auth_controller.dart
│   │   │   ├── data/
│   │   │   │   ├── datasources/
│   │   │   │   │   ├── auth_local_datasource.dart
│   │   │   │   │   └── auth_remote_datasource.dart
│   │   │   │   ├── models/
│   │   │   │   │   └── user_model.dart
│   │   │   │   └── repositories/
│   │   │   │       └── auth_repository_impl.dart
│   │   │   ├── domain/
│   │   │   │   ├── entities/
│   │   │   │   │   └── user_entity.dart
│   │   │   │   ├── repositories/
│   │   │   │   │   └── auth_repository.dart
│   │   │   │   └── usecases/
│   │   │   │       ├── get_user_usecase.dart
│   │   │   │       └── login_usecase.dart
│   │   │   └── presentation/
│   │   │   │   ├── widgets/
│   │   │   │   │   └── login_form.dart
│   │   │   │   └── views/
│   │   │   │       └── login_view.dart
│   │   │   └── routes/
│   │   │       └── auth_routes.dart
│   │   └── home/
│   │       ├── bindings/
│   │       │   └── home_binding.dart
│   │       ├── controllers/
│   │       │   └── home_controller.dart
│   │       ├── data/
│   │       │   ├── datasources/
│   │       │   │   ├── home_local_datasource.dart
│   │       │   │   └── home_remote_datasource.dart
│   │       │   ├── models/
│   │       │   │   └── item_model.dart
│   │       │   └── repositories/
│   │       │       └── home_repository_impl.dart
│   │       ├── domain/
│   │       │   ├── entities/
│   │       │   │   └── item_entity.dart
│   │       │   ├── repositories/
│   │       │   │   └── home_repository.dart
│   │       │   └── usecases/
│   │       │       └── get_items_usecase.dart
│   │       └── presentation/
│   │           ├── widgets/
│   │           │   └── item_card.dart
│   │           └── views/
│   │               └── home_view.dart
│   ├── services/
│   │   ├── api_service.dart
│   │   ├── auth_service.dart
│   │   └── storage_service.dart
│   └── shared/
│       ├── widgets/
│       │   └── custom_button.dart
│       └── components/
│           └── loading_indicator.dart
└── pubspec.yaml

🔧 Troubleshooting

Issue: Command not found

# Make sure Dart pub global bin is in your PATH
export PATH="$PATH":"$HOME/.pub-cache/bin"

Issue: Template not copying

# Reinstall the CLI
dart pub global deactivate get_clean
dart pub global activate get_clean

📝 License

MIT License - feel free to use for personal and commercial projects!

🤝 Contributing

Found a bug or have a suggestion? Open an issue on GitHub!