🚀 FlutterMeUp (FMU) Generator #

A lightning-fast, interactive CLI tool designed to instantly scaffold production-ready GetX architectures for Flutter projects.

Stop wasting hours manually creating folders, writing repetitive GetxController boilerplate, or wiring up app_routes.dart. Run a single command and jump straight into building features for your Android, iOS, or Windows desktop apps.

📦 Installation #

This package is designed to be used at the project level as a dev dependency, ensuring that your team's environment stays clean and version-locked.

Navigate to your existing Flutter project and run:

flutter pub add dev:fluttermeup

(Note: Ensure your pubspec.yaml allows Dart SDK ^3.0.0)

🛠️ Getting Started (The Workflow) #

The standard workflow takes less than 30 seconds from a blank project to a fully wired GetX domain.

1. Create a fresh Flutter project:

flutter create project_name
cd project_name

2. Add the generator:

flutter pub add dev:fluttermeup

3. Initialize the architecture:

dart run fluttermeup:fmu init

4. Generate a complete domain feature:

dart run fluttermeup:fmu make:feature employee

💻 Available Commands #

init #

Command: dart run fluttermeup:fmu init

Wipes the default Flutter counter app and injects a complete GetX routing architecture.

• Auto-installs get, toastification, and path_provider.
• Scaffolds standard enterprise folders (models, views, api, repositories, helpers, etc.).
• Creates a dynamic, immersive main.dart that automatically scales between portrait (mobile) and landscape (Windows/desktop).
• Sets up the initial StartupView, StartupController, and wiring in app_routes.dart.

make:helper #

Command: dart run fluttermeup:fmu make:helper

Generates a robust JsonHelper utility inside lib/helpers/. This cross-platform helper perfectly manages local JSON reading/writing across Windows, Android, iOS, and macOS directories without throwing pathing errors.

make:feature #

Command: dart run fluttermeup:fmu make:feature <name>

Instantly generates the data layer for a specific domain. By default, it creates the Model, API, and Repository, and automatically links them together.

Flags: You can specify exactly what to generate using flags:

• --model: Generates only the data model.
• --api: Generates only the GetConnect API service.
• --repo: Generates only the Repository.

✨ Interactive Repository Checking: If you try to generate a Repository (--repo) but the Model or API doesn't exist yet, the CLI will pause and ask you how you want to configure it. You can choose to auto-generate the missing files, link to local-storage only, or create an empty repository safely!

make:view #

Command: dart run fluttermeup:fmu make:view <name>

Generates the complete UI layer for a feature.

• Creates name_page.dart, name_controller.dart, and name_binding.dart.
• Auto-Injects: It seamlessly opens your app_routes.dart and app_pages.dart files and injects the new routes and imports automatically. No manual routing required!

📂 Generated Architecture #

Running the init and make commands leaves you with a beautifully structured, scalable project:

lib/
├── api/                   # Network calls (GetConnect)
├── app/
│   └── routes/            # Auto-generated app_pages.dart & app_routes.dart
├── helpers/               # JsonHelper and custom utilities
├── models/                # JSON serialization classes
├── repositories/          # Middleman between API and Controllers
├── services/              # Global background services
├── utilities/             # Constants, themes, etc.
├── views/                 # UI Layer (Pages, Controllers, Bindings)
│   ├── startup/
│   └── employee/          
├── widgets/               # Reusable UI components
└── main.dart              # Immersive, responsive entry point

📄 License #

This project is licensed under the MIT License - see the LICENSE file for details. Built to be helpful. Use it, modify it, and speed up your workflow!