Skip to content

Commit 4b57785

Browse files
committed
Update Readme
1 parent a6454a4 commit 4b57785

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

README.md

+50-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# flutter_bloc_template
2-
The perfect flutter template using bloc.
1+
# flutter-bloc-template 🚀
2+
The project of the empty template with Flutter has built the basic framework to realize the functions of internationalization, theme peeling etc.
3+
4+
## How to use
5+
Just click on [![Use this template](https://img.shields.io/badge/-Use%20this%20template-brightgreen)](https://github.com/ashtanko/flutter_bloc_app_template/generate) button to create a new repo starting from this template.
6+
7+
## Features
8+
Feature | Usage
9+
------------ | -------------
10+
[retrofit](https://pub.dev/packages/retrofit#-readme-tab-) | For working with restful API, generated model
11+
[json_annotation](https://pub.dev/packages/json_annotation#-readme-tab-) | Same as above (SAA)
12+
[dio](https://pub.dev/packages/dio) | SAA
13+
[build_runner](http://build_runner) | SAA
14+
[flutter_bloc](https://pub.dev/packages/flutter_bloc) | For build app architecture
15+
[freezed](https://pub.dev/packages/freezed) | Working with State of bloc
16+
[equatable](https://pub.dev/packages/equatable) | SAA
17+
[shared_preferences](https://pub.dev/packages/shared_preferences) | For caching user’s session
18+
[firebase_core](https://pub.dev/packages/firebase_core) | For register account and login using Firebase
19+
[google_sign_in](https://pub.dev/packages/google_sign_in) | SAA
20+
[firebase_auth](https://pub.dev/packages/firebase_auth) | SAA
21+
22+
## How to build
23+
24+
Before run project, execute this commands:
25+
- `flutter clean`
26+
- `flutter pub get`
27+
- `flutter pub run build_runner build` or `flutter pub run build_runner build --delete-conflicting-outputs`
28+
- `flutter run` (if needed)
29+
30+
## Reminders
31+
Change name in pubspec.yaml file
32+
33+
Remove anything you don't need
34+
35+
Configure analysis_options.yaml for your needs
36+
37+
## Contributing
38+
39+
Feel free to open a issue or submit a pull request for any bugs/improvements.
40+
41+
## Support
42+
If you like my work and want to support give a ⭐ to the repo.
43+
44+
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/mitinoh)
45+
46+
Thank you so much ❤️.
47+
48+
## License
49+
50+
This project is under MIT License. See [LICENSE](https://github.com/mitinoh/flutter_bloc_template/blob/main/LICENSEE) for more details.

0 commit comments

Comments
 (0)