Flutter Riverpod Feature

Getting Started 🚀

mason make nk_riverpod_feature --feature_name auth --local_datasource true --fake_datasource true

Variables ✨

Requirements 💞

• flutter_riverpod

Outputs 📦

└── lib
    └── features
        └── auth
            ├── README.md
            ├── application
            │   └── .gitkeep
            ├── data
            │   ├── auth.datasource.dart
            │   ├── auth.remote.datasource.dart
            │   ├── auth.repository.impl.dart
            │   └── auth.response.dart
            ├── data.dart
            ├── domain
            │   ├── auth.entity.dart
            │   └── auth.repository.dart
            ├── domain.dart
            ├── presentation
            │   ├── auth.controller.dart
            │   ├── auth.page.dart
            │   └── widgets
            │       └── .gitkeep
            ├── presentation.dart
            ├── shared
            │   └── auth.providers.dart
            └── shared.dart

└── test
    └── features
        └── auth
            ├── application
            │   └── .gitkeep
            ├── data
            │   ├── auth.remote.datasource_test.dart
            │   └── auth.repository.impl_test.dart
            ├── domain
            │   └── .gitkeep
            └── presentation
                ├── auth.controller_test.dart
                ├── auth.page_test.dart
                └── widgets
                    └── .gitkeep

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 nk_riverpod_feature

# Install globally
mason add -g nk_riverpod_feature

Usage 🚀

mason make nk_riverpod_feature

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.0.7

• folder added for application layer
• refactoring post_gen hook

0.0.6

• added export files for layers
• flutter_riverpod is added to post_gen hook as a dependency in pubspec.yaml

0.0.5

• test output documented in readme

0.0.4

• added data source generation options
• generate feature tests

0.0.3

• refactoring

0.0.2+4

• added abstract datasource class

0.0.1+3

• fix folderstructure
• brick documented

0.0.1+2

• fix readme.md

0.0.1+1

• Flutter Riverpod architecture created

Copyright 2022 Nico Klage

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.