flgen 0.0.1+6
flgen: ^0.0.1+6 copied to clipboard
CLI to scaffold Flutter architecture and features.
π¦ Set Up Flutter Architecture #
This repository provides scripts to automate the setup of a base architecture for Flutter projects. It simplifies the generation of essential folders and files, allowing you to start development quickly and in an organized way.
π What's Included? #
- core: Creates the main folder structure of the project.
- feature: Generates the structure for a new feature or module.
- base: Runs both previous scripts to set up the full project architecture and install packages.
π οΈ Prerequisites #
- Flutter installed on your system.
- Access to a terminal with an internet connection.
βοΈ Installation & Usage #
You can install flgen globally using:
dart pub global activate flgen
1. Set up the complete architecture #
flgen base
2. Set up only the core structure #
flgen core
3. Add a new feature or module #
flgen feature <name>
π Generated Folder Structure #
The following folder structure is created:
lib/
βββ core/
β βββ animations/
β βββ config/
β βββ constants/
β βββ errors/
β βββ routes/
β βββ theme/
β βββ utils/
β βββ widgets/
βββ features/
β βββ example_feature/
β βββ domain/
β βββ infrastructure/
β βββ presentation/
βββ main.dart
βββ .env
βββ .env.dev
Note: You can customize folder and file names based on your projectβs needs.
π€ Contributions #
Contributions are welcome! If you'd like to improve or add new functionality, feel free to open an issue or submit a pull request.