hello_riverpod

A complete starter project for Flutter apps.

With hello_riverpod, you can easily create a new Flutter project that follows the guidelines of Clean Architecture, and with all the basic packages ready to use (riverpod, go_router, freezed, intl, mocktail).

Prerequisites

Installed version of Mason

Installed version of Very Good CLI ✅ hello_riverpod tested with version 0.9.1

Why are we using Very Good CLI ?

Very Good Core provides all the configuration we need for a new project with several flavors. This has become a standard for many developers, even for those using Riverpod. The problem is that 'very_good create' generates projects with an architecture based on BLoC.

Thanks to hello_riverpod, you now have a way to generate a 'Very Good project', and clean it in a way that makes it ready to use Riverpod instead of BLoC.

Get Started

All you need is this script. Download it and save it under the name gen.sh in a folder where you want to create your new projects.

Then, you just have to run :

./gen.sh

And follow the instructions.

Your projects will be added in a folder named HELLOWORLDS/

Feel free to create an issue if you have any question.

Cheers ✨

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 hello_riverpod

# Install globally
mason add -g hello_riverpod

Usage 🚀

mason make hello_riverpod

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

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

0.2.0+3

• Simplified version in order to change architecture from layer to feature oriented

0.1.0+1

• Initial release.

MIT License

Copyright (c) 2022 Jean Vallon (I Code You)

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.