getx_boilerplate_cli 1.0.0
getx_boilerplate_cli: ^1.0.0 copied to clipboard
Command-line interface to generate premium Flutter starter boilerplates utilizing GetX and Clean Architecture.
GetX Boilerplate CLI 🚀 #
A powerful command-line interface tool to instantly scaffold a premium, production-ready Flutter starter template built with GetX, Clean Feature-First Architecture, Centralized Dependency Injection, Singleton Routing, and Premium Common UI Components.
This tool clones the official parentroots/getx boilerplate template and automatically customizes the package name, imports, and directories to match your new project name.
⚡ Quick Start #
1. Install the CLI globally #
Activate the CLI tool globally on your machine:
dart pub global activate getx_boilerplate_cli
Note: Make sure your system's PATH includes the Dart SDK pub-cache/bin directory so you can execute the command directly.
2. Scaffold a new project #
Generate a new premium Flutter project in your current directory:
getx_boilerplate_cli create my_awesome_app
This command will automatically:
- Clone the latest production-ready template from GitHub.
- Clean the git history so you start with a fresh repository.
- Search & Replace all occurrences of
getx_templatewithmy_awesome_appin imports, configurations (pubspec.yaml, manifests, etc.), and native folders. - Resolve dependencies automatically by running
flutter pub getinside the new folder.
🛠️ Boilerplate Key Features #
The generated project contains an enterprise-grade setup containing:
- 🏢 Feature-First Clean Architecture: Highly organized modules (data, screen, controller, widget) optimized for scale.
- 📦 Dependency Injection: Centralized, memory-efficient global bindings using GetX.
- 🛣️ Singleton Routing: Standardized routes mapping configuration in a single file.
- 🌐 High-Performance Network Client: Custom
ApiClient(Dio Singleton) with automatic request logs, token injection, and error handling. - 📱 Connectivity Service: Real-time observer showing internet status dynamically.
- 🎨 Curated Common UI Components: Customizable components like
CommonAppBar,CommonImage,CommonDatePicker,CommonMultiImagePicker,CommonSearchBar, and more.
🚀 Getting Started with the Generated App #
After generating the app:
cd my_awesome_app
flutter run
📄 License #
This CLI tool and the template are licensed under the MIT License. For more details, check out the GitHub Repository.