Clean Architecture Kit 🏗️
A powerful Command-Line Interface (CLI) tool designed to jumpstart your Flutter development with a robust, scalable, and maintainable Clean Architecture structure.
🌟 Features
- Instant Boilerplate: Generate a fully structured Flutter project in seconds.
- Clean Architecture: Pre-configured layers (Data, Domain, Presentation) to ensure separation of concerns.
- Version Control: Pull specific template versions (branches/tags) or auto-detect the latest release.
- Smart Configuration: Automatically renames the internal package references and runs
flutter pub get. - Fresh Start: Resets git history so you can begin your project with a clean slate.
🚀 Getting Started
Prerequisites
Ensure you have the following installed on your system:
Installation
Install the package globally via pub.dev:
dart pub global activate clean_architecture_kit
Note: Make sure your pub cache bin directory is in your system path.
🛠️ Usage
Once installed, you can use the clean_archi command.
Create a new project
clean_archi -n my_awesome_app
This will auto-detect the latest stable version of the template and clone it.
Create with a specific version
clean_archi -n my_awesome_app -v v1.0.0
List available versions
Check what templates are available in the repository:
clean_archi -l
Show help
clean_archi -h
📂 Project Structure
The generated project follows a standard Clean Architecture pattern:
lib/
├── core/ # App-wide constants, themes, and utilities
├── features/ # Feature-based logic
│ └── feature_name/
│ ├── data/ # Repositories implementation and data sources
│ ├── domain/ # Entities and Use Cases
│ └── presentation/ # UI Components and Blocs/Providers
└── main.dart
🤝 Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request on the GitHub repository.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
Libraries
- clean_architecture_kit
- Support for doing something awesome.