Skip to content

Commit bf46482

Browse files
committed
Updated ReadMe
1 parent 05b8720 commit bf46482

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

+23-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
11
# get-flutter-fire
22

3-
Boilerplate for Flutter with GetX and Firebase
3+
This codebase provides a boilerplate code utilizing the following three technologies:
44

5-
Use the git version history to learn step by step
5+
1. Flutter 3.0 - For UX and uses Dart languange. See [https://flutter.dev/]
6+
2. GetX - State management for Flutter. See [https://github.com/jonataslaw/getx/tree/4.6.1]
7+
3. Firebase - For Backend as a Service. See [https://firebase.google.com/]
8+
1. Easy Authentication flow
9+
2. Server side functions
10+
3. Remote Configurations which can be used for A/B testing
611

7-
Step 1: Use Get CLI https://pub.dev/packages/get_cli
12+
This was created as part of my own learning process and you will find that git commits were made according to the Steps listed below. You can use the git version history to check each commit and learn step by step, as I did.
13+
14+
I am also using this codebase as an experiment towards hiring people (freshers especially but not limited to them) for my development team. If you are in Mumbai and are interested to join my team, you can use this codebase in the following manner:
15+
16+
* Fork the codebase
17+
* Build your own application using this as a base, or complete a TODO or fix a bug
18+
* Send me a Pull Request. Mention a way of connecting with you in the commit message along with details of commit. Also modify ReadMe to say what you have changed in detail.
19+
* I will go through the request and then connect with you if I find the entry to be interesting and take an interview round.
20+
21+
22+
## The Steps
23+
24+
Step 1: Use Get CLI [https://pub.dev/packages/get_cli]
825

926
`get create project`
1027

11-
Step 2: Copy code from https://github.com/jonataslaw/getx/tree/4.6.1/example_nav2/lib
28+
Step 2: Copy code from [https://github.com/jonataslaw/getx/tree/4.6.1/example_nav2/lib]
1229

1330
Step 3: Integrate FlutterFire Authentication
1431

@@ -81,13 +98,13 @@ Step 9: Add User Roles using Custom Claims. This requires upgrade of plan as we
8198
2. Created Navigation for each of Admin, Buyer, Seller screens
8299
3. Allowed switch from lower role Navigation to Navigation view till the given role of the user
83100

84-
Step 10: TODO: Firebase Remote Config for A/B testing. See [https://firebase.google.com/docs/remote-config]
101+
Step 10: Firebase Remote Config for A/B testing. See [https://firebase.google.com/docs/remote-config]
85102

86103
1. Complete the Screen enum based Navigation framework
87104
2. Config useBottomSheetForProfileOptions for Navigation element to be one of the following
88105
* False: Drawer for Account, Settings, Sign Out
89106
* True: Hamburger that opens BottomSheet (Context Menu in larger screen) for the same options
90-
3. Config for adding Search Bar at the Top vs a Bottom Navigation button
107+
3. TODO: Config for adding Search Bar at the Top vs a Bottom Navigation button
91108

92109
Step 11: TODO: CRUD
93110

0 commit comments

Comments
 (0)