Flutter Production Boilerplate Riverpod
A flutter project containing riverpod, flutter_lints, hive, easy_translations and more!
This repository is the starting point for my personal projects. If you have any suggestions or improvements feel free to let me know. The project strives to implement best practices recommended by Google and other developers. These best practices include but are not limited to:
- Using Riverpod for state management.
- Using Flutter Lints for stricter linting rules.
- Using Hive for platform independent storage that also works for web.
- Project structure, const constructors, extracted widgets and many more...
Installation
This repository requires Flutter to be installed and present in your development environment.
Clone the project and enter the project folder.
git clone https://github.com/anfeichtinger/flutter_production_boilerplate_riverpod.git
cd flutter_production_boilerplate_riverpod
You can remove the screenshots located in assets/img/.
Get the dependencies.
flutter pub get
Run the app via command line or through your development environment. (optional)
flutter run lib/main.dart
Pub packages
This repository makes use of the following pub packages:
| Package | Version | Usage |
|---|---|---|
| Riverpod | ^1.0.4 | State management* |
| Flutter Lints | ^2.0.1 | Stricter linting rules |
| Path Provider | ^2.0.10 | Get the save path for Hive |
| Flutter Displaymode | ^0.4.0 | Support high refresh rate displays |
| Easy Localization | ^3.0.1 | Makes localization easy |
| Hive | ^2.2.1 | Platform independent storage. |
| Url Launcher | ^6.1.2 | Open urls in Browser |
| Ionicons | ^0.1.2 | Modern icon library |
* Recommended to keep regardless of your project
Using this package as a starting point
After following the installation steps you can customize your project. The screens and widgets that are inside the project can be easily replaced or removed. They are supposed to give the user a basic understanding of the relations between widgets and some good practices. The code includes some comments with documentation and examples. The examples can be found by searching for "Example:" inside the project files.
Changing the package and app name
You can follow the instructions in this Stackoverflow issue.
Theme
You can customize your brand colors in the lib/config/theme.dart file. The project uses colors from TailwindCSS. As primary swatch the indigo color palette is used while for the text the gray color palette is used. Feel free to replace those values with your own. In order to get a smooth transition for the text colors it is necessary to override each text type in the TextTheme.
Removing unwanted packages
If a package is not listed, then removing it from pubspec.yaml as well as all imports and uses should be enough. This is required for removing every packages, the following instructions are an addition to that.
Flutter Lints
Delete the analysis_options.yaml file. As an alternative you can modify the rules in this file or use a different package like Lint.
Easy Localization
Remove the assets/translations folder. Go to ios/Runner/Info.plist and remove the following code:
CFBundleLocalizations
en
de
Url Launcher
For iOS go to ios/Runner/Info.plist and remove the following code:
LSApplicationQueriesSchemes
https
http
For Android you can take a look at this Stackoverflow issue for more information. Go to android/app/src/AndroidManifest.xml and add the following code:
">
[...]
0 Jan 8, 2022
1 May 10, 2022
7 Dec 6, 2022
4 Dec 8, 2022
891 Jan 3, 2023
94 Dec 6, 2022
1 Jun 11, 2022
2 Sep 28, 2022
14 Nov 23, 2022
14 Jan 1, 2023