Feature Based Skeleton

A project template for busy developers to fastly create a new flutter project using the atomic & CSR (Controller Service Repository) feature brick design. Dependencies: flutter_riverpod, freezed class generation, json serializable, build runner.

After deploying this brick, check the Atomic CSR Feature and deploy it inside the "features" folder to easily deploy new features.

How to use 🧾

mason add feature_based_skeleton && mason make feature_based_skeleton

Dont forget to run flutter pub get after deploying the brick / new project.

Variables ⚙️

Output 🏠

assets/
lib/
├─ core/
│  ├─ shared/
│  │  ├─ shared stuff
│  ├─ widgets/
│  │  ├─ core widgets of the app
│  ├─ project_name_app.dart
│  ├─ project_name_core.dart
├─ theme/
│  ├─ color_schemes.dart
│  ├─ project_name_theme.dart
├─ features/
├─ routes/
├─ main.dart
test/
├─ test widgets
analysis_options.yaml
package_name.iml
pubspec.yaml
README.md
...

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 feature_based_skeleton

# Install globally
mason add -g feature_based_skeleton

Usage 🚀

mason make feature_based_skeleton

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

0.2.0+1

• initial public release & synced version for atomic_csr_feature.

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

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.