Flutter Clean Architecture

A new brick created with the Mason CLI for generating a Flutter project scaffolded according to Clean Architecture principles.

Overview

This Mason brick provides a quick start to a new Flutter project using Clean Architecture. It includes predefined project structure, core components, optional REST API setup, Riverpod for state management, and VSCode settings. It's ideal for projects where you want a scalable and maintainable architecture from the get-go.

Features

• Predefined project structure following Clean Architecture principles.
• Optional RESTful API integration.
• Riverpod for state management (optional).
• VSCode configuration including launch.json and settings.json (optional).
• Core components for networking, logging, navigation, secure storage, theming, and user management.

Output

****
├── assets
│   ├── fonts
│   └── images
│       └── sample_image.jpg
├── lib
│   ├── app_wd.dart
│   ├── core
│   │   ├── app_config
│   │   │   ├── app_config.dart
│   │   │   └── src
│   │   │       ├── app_config.dart
│   │   │       └── src.dart
│   │   ├── core.dart
│   │   ├── [project_key.lowerCase()]_logger
│   │   │   ├── src
│   │   │   │   ├── src.dart
│   │   │   │   └── [project_key.lowerCase()]_logger.dart
│   │   │   └── [project_key.lowerCase()]_logger.dart
│   │   ├── [project_key.lowerCase()]_navigation
│   │   │   ├── src
│   │   │   │   ├── src.dart
│   │   │   │   ├── utils
│   │   │   │   │   ├── constants
│   │   │   │   │   │   ├── constants.dart
│   │   │   │   │   │   ├── route_paths.dart
│   │   │   │   │   │   └── routes.dart
│   │   │   │   │   ├── keys
│   │   │   │   │   │   ├── keys.dart
│   │   │   │   │   │   └── [project_key.lowerCase()]_global_navigator_keys.dart
│   │   │   │   │   └── utils.dart
│   │   │   │   ├── widgets
│   │   │   │   │   ├── not_found_page.dart
│   │   │   │   │   └── widgets.dart
│   │   │   │   └── [project_key.lowerCase()]_navigation.dart
│   │   │   └── [project_key.lowerCase()]_navigation.dart
│   │   ├── [project_key.lowerCase()]_secure_storage
│   │   │   ├── src
│   │   │   │   ├── src.dart
│   │   │   │   └── [project_key.lowerCase()]_secure_storage.dart
│   │   │   └── [project_key.lowerCase()]_secure_storage.dart
│   │   ├── [project_key.lowerCase()]_theme
│   │   │   ├── src
│   │   │   │   ├── design_system.dart
│   │   │   │   ├── src.dart
│   │   │   │   └── [project_key.lowerCase()]_theme.dart
│   │   │   └── [project_key.lowerCase()]_theme.dart
│   │   └── [project_key.lowerCase()]_user
│   │       ├── src
│   │       │   ├── src.dart
│   │       │   └── [project_key.lowerCase()]_user.dart
│   │       └── [project_key.lowerCase()]_user.dart
│   ├── features
│   │   └── home
│   │       └── homepage.dart
│   ├── main.dart
│   ├── main_run_app.dart
│   └── utils
│       ├── base_classes
│       │   ├── base_classes.dart
│       │   ├── base_result.dart
│       │   ├── base_result.freezed.dart
│       │   └── base_usecase.abs.dart
│       ├── constants
│       │   ├── common_messages.dart
│       │   └── constants.dart
│       ├── exceptions
│       │   ├── any_exception.abs.dart
│       │   ├── exceptions.dart
│       │   ├── unkown_exception.dart
│       │   └── [is_rest_api_app]internet_connection_exception.dart
│       ├── utils.dart
│       └── [is_using_riverpod]riverpod
│           ├── riverpod.dart
│           └── [project_key.lowerCase()]_state_notifier.dart
└── pubspec.yaml

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add flutter_clean_architecture

# Install globally
mason add -g flutter_clean_architecture

Usage 🚀

mason make flutter_clean_architecture

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.51 <0.1.0"

0.1.0

• Initial release of the flutter_clean_architecture Mason brick.
• Core architecture setup including app_config, logger, navigation, secure_storage, theme, and user modules.
• Optional REST API integration with dio client and network manager.
• State management setup using flutter_riverpod (optional).
• Base classes for result handling and use case abstraction.
• Constants and common messages utility.
• Exception handling mechanism including common exceptions.
• VSCode configuration (launch.json and settings.json) templates.
• Sample assets.
• Home feature module with a basic homepage setup.
• Utils directory with base classes, constants, exceptions, and optional riverpod integration. Dependencies and dev_dependencies setup in pubspec.yaml.

MIT License

Copyright (c) 2024 SINUT WATTANARPORN

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.