Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SimpleBoilerplates/Flutter
A boilerplate project for Flutter using RiverPod, Dio, go_router, Freezed and generated with very_good_cli
https://github.com/SimpleBoilerplates/Flutter
android bloc bloc-pattern dart dio flutter flutter-apps flutter-examples freezed ios riverpod rxdart
Last synced: 3 months ago
JSON representation
A boilerplate project for Flutter using RiverPod, Dio, go_router, Freezed and generated with very_good_cli
- Host: GitHub
- URL: https://github.com/SimpleBoilerplates/Flutter
- Owner: SimpleBoilerplates
- License: mit
- Created: 2019-05-21T18:57:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T08:44:02.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T12:25:46.603Z (6 months ago)
- Topics: android, bloc, bloc-pattern, dart, dio, flutter, flutter-apps, flutter-examples, freezed, ios, riverpod, rxdart
- Language: Dart
- Homepage:
- Size: 2.06 MB
- Stars: 553
- Watchers: 22
- Forks: 102
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flutter Boilerplate
![coverage][coverage_badge]
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
[![License: MIT][license_badge]][license_link]
A boilerplate project for Flutter using [RiverPod](https://riverpod.dev/), [Dio](https://pub.dev/packages/dio), [go_router](https://pub.dev/packages/go_router), [Freezed](https://pub.dev/packages/freezed) and generated with [very_good_cli](https://github.com/VeryGoodOpenSource/very_good_cli).
---
This is a very simple Boilerplate application, this has following features.
- User can Sign In and Up
- After signing in he can see a list of items
> It uses a mock json server which doesn't store or validate anything, so for signing in/up any email, password will simply work.
[RiverPod](https://riverpod.dev/) was used for state management, but there's an old implementation with [Flutter bloc](https://bloclibrary.dev/#/) as well, you may check out [bloc](https://github.com/SimpleBoilerplates/Flutter/tree/bloc) branch, though that branch doesn't have many of the latest changes.
## Getting Started 🚀
You can go through this [Flutter Starter Pack](https://sadmansamee.github.io/flutter_starter_pack).
This project contains 3 flavors:
- development
- staging
- production
To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
```sh
# Development
$ flutter run --flavor development --target lib/main_development.dart
# Staging
$ flutter run --flavor staging --target lib/main_staging.dart
# Production
$ flutter run --flavor production --target lib/main_production.dart
```
_\*Flutter Boilerplate works on iOS, Android, and Web._
---
## Use MakeFile / Derry to avoid writing your own scripts.
You can run all these scripts manually or could use [MakeFile](https://github.com/SimpleBoilerplates/Flutter/blob/master/makefile) / [Derry](https://pub.dev/packages/derry) and maintain a file, where you can define all those scripts and run in a very convinient way. All the scripts for this project is defined here [derry scripts](https://github.com/SimpleBoilerplates/Flutter/blob/master/derry.yaml) and [makefile scripts](https://github.com/SimpleBoilerplates/Flutter/blob/master/makefile)
Example:
run `make watch` or `derry watch` instead of
```sh
flutter pub run build_runner watch --delete-conflicting-outputs
```
run `make build` or `derry build` instead of
```sh
flutter pub run build_runner build --delete-conflicting-outputs
```
or run `make build_apk_dev` or `derry build_apk_dev` instead of
```sh
flutter build apk --flavor development -t lib/main_development.dart
```
---
## Running Tests 🧪
To run all unit and widget tests use the following command:
```sh
$ flutter test --coverage --test-randomize-ordering-seed random
```
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).
```sh
# Generate Coverage Report
$ genhtml coverage/lcov.info -o coverage/
# Open Coverage Report
$ open coverage/index.html
```
---
## Working with Translations 🌐
### Adding Strings
1. To add a new localizable string, open the `app_en.arb` file at `assets/land/arb/en.json`.
```json
{
"home" : "Home",
"loading" : "Loading",
"email" : "Email",
"password" : "Password",
"name" : "Name",
"sign_in" : "Sign In",
"sign_up" : "Sign Up"
}
```
2. After adding new
```dart
import 'package:easy_localization/easy_localization.dart';
@override
Widget build(BuildContext context) {
return Text("helloWorld".tr());
}
```
### Same implementation in other platforms
- [iOS](https://github.com/simpleboilerplates/BooksDemoiOS)
- [Android](https://github.com/SimpleBoilerplates/Android)
- [React Native](https://github.com/SimpleBoilerplates/React-Native)
- [NodeJS backend](https://github.com/simpleboilerplates/BooksDemoNode)
---
### TODO
- Updating it on daily basis as much as possible, work in progess[WIP].
### Found this project useful :heart:
* Support by clicking the :star: button on the upper right of this page. :v:
---
### Find me at
- [LinkedIn](https://www.linkedin.com/in/sadmansamee/)
- [Github](https://github.com/Sadmansamee)
- [Blog](https://sadmansamee.github.io/)
- [Twitter](https://twitter.com/SameeSadman)
## License
[](https://creativecommons.org/publicdomain/zero/1.0/)
[coverage_badge]: coverage_badge.svg
[flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html
[internationalization_link]: https://flutter.dev/docs/development/accessibility-and-localization/internationalization
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli