πŸ“¦ 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.

Libraries

base
core
feature