riverpod_clean_architecture

A brick to create Clean Architecture Folders.

Generated by mason 🧱

Getting Started 🚀

 mason make riverpod_clean_architecture

Output 📦

Generated folder architecture

lib/
├── app/
│   ├── data/
│   │   ├── datasources/
│   │   │   ├── cache/
│   │   │   │   └── example_cds.dart
│   │   │   ├── memory/
│   │   │   │   └── example_mds.dart
│   │   │   └── remote/
│   │   │       └── example_rds.dart
│   │   ├── imp_repositories/
│   │   │   └── example_imp_repository.dart
│   │   └── models/
│   │       └── remote_model.dart
│   ├── domain/
│   │   ├── data_repositories/
│   │   │   └── example_data_repository.dart
│   │   ├── entities/
│   │   │   └── example_entity.dart
│   │   └── use_cases/
│   │       └── use_case.dart
│   └── presentation/
│       ├── common/
│       │   ├── utils/
│       │   │   └── mappers.dart
│       │   └── widgets/
│       │       └── component.dart
│       └── pages/
│           └── home/
│               ├── notifier/
│               │   └── home_notifier.dart
│               ├── widgets/
│               │   └── home_component_widget.dart
│               └── home_page.dart
└── core/
    ├── error/
    │   └── error.dart
    ├── providers/
    │   └── general_providers.dart
    ├── routes/
    │   └── routes.dart
    ├── themes/
    │   └── light_theme.dart
    └── utils/
        └── extensions.dart

License 🍀

MIT License

Copyright (c) 2022 Álvaro Prado

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.

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 riverpod_clean_architecture

# Install globally
mason add -g riverpod_clean_architecture

Usage 🚀

mason make riverpod_clean_architecture

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

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

0.1.0+1

• Create initial brick structure

MIT License

Copyright (c) 2022 Álvaro Prado

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.