getx_boilerplate_cli 1.0.1

Command-line interface to generate premium Flutter starter boilerplates utilizing GetX and Clean Architecture.

GetX Boilerplate CLI 🚀

An enterprise-grade, developer-friendly Command-Line Interface (CLI) tool to instantly scaffold a premium Flutter starter template. Built upon Clean Feature-First Architecture, GetX, Centralized Dependency Injection, Singleton Routing, and deeply customizable Premium UI Components.

Instead of manually cloning a repository and performing tedious search-and-replace naming configurations, this CLI automates the entire process in seconds!

---

⚡ Quick Start

1. Install the CLI Globally

Activate the CLI tool on your local machine using the Dart SDK package manager:

dart pub global activate getx_boilerplate_cli

Tip

Ensure your system's PATH environment variable includes the Dart SDK pub-cache/bin directory so you can run the command directly from any terminal.

2. Scaffold a New Project

Run the create command followed by your desired project name (in lowercase with underscores):

getx_boilerplate_cli create my_awesome_app

---

⚙️ What the CLI Handles Automatically

When you run the create command, the CLI performs the following tasks:

• 📥 Repository Cloning: Clones the absolute latest production-ready template from parentroots/getx.
• 🧹 Git History Cleanup: Deletes the cloned .git directory so you start with a clean git history for your team.
• 🔧 Smart Package Renaming: Recursively scans and renames all namespace declarations and imports from getx_template to my_awesome_app (in pubspec.yaml, Dart source files, Android package manifests, Kotlin imports, iOS configurations, and CMake build configurations).
• 📂 Directory Sorting: Renames files and directory packages containing getx_template to match your new project.
• 📦 Dependency Resolution: Automatically runs flutter pub get inside the generated project directory so it's ready to run immediately.

---

🏗️ Generated Project Architecture

The generated project is structured using the industry-proven Clean Feature-First Architecture:

lib/
├── core/                   # App-wide foundations & configurations
│   ├── bindings/           # Centralized global Dependency Injection (FENIX-enabled)
│   ├── config/             # App lifecycle observers & configurations
│   ├── constants/          # Static app constants (API, storage keys, colors, strings)
│   ├── errors/             # Global error handling logic & custom exceptions
│   ├── localization/       # Internationalization & translations
│   ├── network/            # Singleton HTTP (Dio) and WebSocket Clients
│   ├── routing/            # Singleton navigation & routes registration
│   ├── theme/              # Curated light/dark theme config, radius, & typography
│   └── utils/              # Helper utilities & extensions
│
├── component/              # Globally shared, highly customizable Common UI widgets
│   ├── dialogs/            # App dialogs & Common Snackbars
│   ├── layout/             # Lists, Grids, Dropdowns, Radios, Scaffolds, and CommonText
│   ├── loading/            # Common shimmers, page loaders & loading overlays
│   ├── pickers/            # Compressed Multi-Image, Date, Time, and Country pickers
│   └── states/             # Empty, Error, Offline, and Retry state views
│
└── features/               # Self-contained modules (Domain layers)
    └── [feature_name]/     # Example: auth, home, profile
        ├── data/           # Module-specific API integrations & data models
        └── screen/         # Flattened UI Presentation Layer (View + Controller)

---

🌟 Boilerplate Key Highlights

• 🏢 Feature-First Clean Architecture: Highly scalable and team-friendly structure.
• 📦 Dependency Injection: Centralized, memory-efficient global bindings using GetX fenix: true lazy instantiations.
• 🛣️ Singleton Routing: Simplified route configurations and transitions in one centralized Singleton class.
• 🌐 High-Performance Network Client: Custom ApiClient (Dio Singleton) with automatic request logs, request headers, token injection, and structured error handling.
• 📱 Connectivity Service: Real-time internet connection observer dynamically checking and alerting connection status.
• 🎨 Curated Common UI Components: Customizable components like CommonAppBar, CommonImage, CommonDatePicker, CommonMultiImagePicker, CommonSearchBar, and more.

---

🚀 Run the Generated App

After generating the app, simply run:

cd my_awesome_app
flutter run

---

📄 License

This project is licensed under the MIT License. See the LICENSE file in the repository for details.