https://github.com/enmanuelmag/flutter-template
https://github.com/enmanuelmag/flutter-template
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/enmanuelmag/flutter-template
- Owner: enmanuelmag
- Created: 2024-11-07T20:23:36.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-12-03T12:36:54.000Z (6 months ago)
- Last Synced: 2025-01-31T22:52:36.440Z (4 months ago)
- Language: Dart
- Size: 1.36 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flutter Production Boilerplate Riverpod
*Note: If you prefer to use BLOC instead of Riverpod you can use [flutter_production_boilerplate_riverpod](https://github.com/anfeichtinger/flutter_production_boilerplate)*
## 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](https://flutter.dev/docs/get-started/install) to be installed and
present in your development environment.
Clone the project and enter the project folder.
```sh
git clone [email protected]:anfeichtinger/flutter_production_boilerplate_riverpod.git
cd flutter_production_boilerplate_riverpod
```
You can remove the screenshots located in [assets/img/](./assets/img).
Get the dependencies.
```sh
flutter pub get
```
Run the app via command line or through your development environment. (optional)
```sh
flutter run lib/main.dart
```
## Pub packages
This repository makes use of the following pub packages:
| Package | Version | Usage |
|-----------------------------------------------------------------------------|----------|--------------------------------------|
| [Flutter Riverpod](https://pub.dev/packages/flutter_riverpod) | ^2.5.1 | State management* |
| [Flutter Lints](https://pub.dev/packages/flutter_lints) | ^4.0.0 | Stricter linting rules* |
| [Flutter Displaymode](https://pub.dev/packages/flutter_displaymode) | ^0.6.0 | Support high refresh rate displays* |
| [Path Provider](https://pub.dev/packages/path_provider) | ^2.1.4 | Get the save path for Hive |
| [Easy Localization](https://pub.dev/packages/easy_localization) | ^3.0.7 | Makes localization easy |
| [Hive](https://pub.dev/packages/hive) | ^2.2.3 | Platform independent storage. |
| [Hive Flutter](https://pub.dev/packages/hive_flutter) | ^1.1.0 | Flutter plugin for hive. |
| [Url Launcher](https://pub.dev/packages/url_launcher) | ^6.3.0 | Open urls in Browser |
| [FluentUI Icons](https://pub.dev/packages/fluentui_system_icons) | ^1.1.255 | Microsoft's open source icon library |
| [Staggered Grid view](https://pub.dev/packages/flutter_staggered_grid_view) | ^0.7.0 | Better grid views |
> \* 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](https://stackoverflow.com/a/51550358) or this [Flutter package](https://pub.dev/packages/change_app_package_name) .
### Theme
You can customize your brand colors in the [lib/config/style.dart](./lib/config/style.dart) file.
The project uses colors from [TailwindCSS](https://tailwindcss.com/docs/customizing-colors). The default theme contains comments that indicate which tailwind color is used. Feel free to replace the colors with your own or use [dynamic material 3 themes](https://github.com/material-foundation/flutter-packages/tree/main/packages/dynamic_color).
### Removing unwanted packages
If a package is not listed, then removing it from [pubspec.yaml](./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](./analysis_options.yaml) file. As an alternative you can modify
the rules in this file or use a different package like [Lint](https://pub.dev/packages/lint).
#### Easy Localization
Remove the [assets/translations](./assets/translations) folder. Go
to [ios/Runner/Info.plist](./ios/Runner/Info.plist) and remove the following code:
```
CFBundleLocalizations
en
de
```
#### Url Launcher
For iOS go to [ios/Runner/Info.plist](./ios/Runner/Info.plist) and remove the following code:
```
LSApplicationQueriesSchemes
https
http
```
For Android you can take a look at this [Stackoverflow issue](https://stackoverflow.com/a/65082750)
for more information. Go
to [android/app/src/AndroidManifest.xml](./android/app/src/main/AndroidManifest.xml) and add the
following code:
```
[...]
```
## Screenshots
#### Light Theme
| Home Light | Info Light |
|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
|  |  |
#### Dark Theme
| Home Dark German | Info Dark German |
|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------|
|  |  |
## License
MIT