devforge 1.4.3
devforge: ^1.4.3 copied to clipboard
CLI tool to generate Flutter/Dart boilerplate code.
devforge #
๐ A powerful CLI for generating Flutter/Dart boilerplate code
Stop writing the same utility files again and again โ let devforge generate them for you.
๐ Documentation & Library API #
This README is the single source of documentation for DevForge. It covers:
- What DevForge is and the problems it solves.
- Installation, requirements, and usage (including all CLI commands).
- Configuration via
devforge.yamland saved user name. - High-level project structure, architecture, coding guidelines, and future work.
DevForge is primarily a CLI tool, not a library intended for direct import.
Public symbols under lib/ (generators, templates, utilities) exist to support
the CLI and are not a stable library API โ prefer running the devforge
executable instead of importing these files directly.
๐ Table of Contents #
- Project Goals
- Features
- Requirements
- Installation
- Example
- Usage
- Configuration
- Output Structure
- Project Structure
- Architecture
- Coding Guidelines
- Future Features
- Development
- License
๐ฏ Project Goals #
| Goal | Description |
|---|---|
| โก Simple Commands | Provide easy-to-use commands for common Flutter workflows |
| ๐ Reduce Repetition | Avoid rewriting the same boilerplate code |
| ๐งญ Dual Modes | Support both direct commands and interactive CLI mode |
โจ Features #
DevForge supports both direct commands and a guided interactive mode.
| Feature | Description |
|---|---|
| ๐ ApiClient Service | Generates api_client.dart with Dio setup + logger_interceptor.dart |
| ๐ฆ Assets Utility | Generates assets_utils.dart with static asset paths |
| ๐ FCM Service | Generates fcm_service.dart for Firebase Cloud Messaging |
| ๐ Refresh Token Service | Creates refresh_token.dart for token refresh handling |
| ๐พ Local Storage Service | Generates SharedPreferences or GetStorage service |
| ๐๏ธ Sqflite Service | Generates SQLite singleton service |
| ๐ Pagination Utilities | Controller + reusable paginated list widgets |
| ๐งฉ BLoC Boilerplate | Generates bloc folder with event/state/bloc |
| ๐ฎ GetX Boilerplate | Generates controller, bindings, and screen |
| ๐ผ App Icon Generator | Generates platform-specific app icons |
| ๐ Localization Generator | Extracts strings and generates translation files |
| ๐ฉบ Flutter Doctor | Runs environment checks |
| ๐งน Cache Cleaning | Runs flutter clean and optional pub cache clean |
| ๐ฆ Flavor Builds | Builds APK/AppBundle/iOS/IPA with optional flavors |
| ๐ Interactive Mode | Use devforge run for a menu-driven experience |
๐ Requirements #
| Requirement | Details |
|---|---|
| Dart SDK | >=3.0.0 <4.0.0 |
| Flutter Project | Generated files are placed inside lib/ |
| PATH | Ensure ~/.pub-cache/bin is in your PATH |
๐ Installation #
Activate globally #
dart pub global activate devforge
### Verify Installation
devforge --help