Atomic C(ontroller) S(ervice) R(epository) Feature

A template for busy developers to fastly deploy a new feature under the Feature Based Skeleton (of course you can use this brick without the skeleton brick) This brick is using atomic design & Controller Service Repository pattern.

NOTE:

1. We are using riverpod as a state management solution in this example. But, since this is a CSR patterned feature, you can change the state management in the example and bring your own state management solution.
2. The theme file & the domain-model file might have exceptions because they depend on firestore & google fonts dependencies. If you want them to work out of the box, add these dependencies.

Fun coding!

How to use: 🧾

cd into the features folder of the project and execute:

mason add atomic_csr_feature && mason make atomic_csr_feature

after the brick has been layed, execute for freezed code generation: flutter pub run build_runner watch --delete-conflicting-outputs

Variables: ⚙️

Output: 🏠

features/
├─ feature_folder_name/
│  ├─ feature_state/
│  │  ├─ feature_state.dart
│  │  ├─ feature_state.freezed.dart
│  ├─ domain/
│  │  ├─ feature_model/
│  │  │  ├─ feature_model.dart
│  │  │  ├─ feature_model.freezed.dart
│  │  │  ├─ feature_model.g.dart
│  ├─ widgets/
│  │  ├─ atoms
│  │  ├─ molecules
│  │  ├─ organisms
│  │  ├─ pages
│  ├─ feature_controller.dart
│  ├─ feature_repository.dart
│  ├─ feature_service.dart
...

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 atomic_csr_feature

# Install globally
mason add -g atomic_csr_feature

Usage 🚀

mason make atomic_csr_feature

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

0.2.0+4

• fixed imports
• fixed typos
• skeleton brick is now available at: Feature Based Skeleton

if there are any issues with the brick, please open a ticket using the "issues" feature of the github project.

0.1.2+3

• Added another variable to seperate feature folder name from feature name for more flexability.
• Bug fixes & improvements for models.
• Bug fixes & improvements for file imports

0.1.1+2

• Hotfixes and improvements upon the architecture.
• Added Domain folder for models.
• Fixed typos in the generated files.
• Added some missing imports.

0.1.0+1

• initial public release (beta).

Copyright 2022 Daniel Toubul

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.