fireflutter 0.2.12 copy "fireflutter: ^0.2.12" to clipboard
fireflutter: ^0.2.12 copied to clipboard

Published 2 years ago • verified publishersonub.com• Latest: 0.3.28
outdated
→

Metadata

A free, open source, complete, rapid development package for creating Social apps, Chat apps, Community(Forum) apps, Shopping mall apps, and much more based on Firebase.

More...

FireFlutter

Fire Flutter #

A free, open source, complete, rapid development package for creating Social apps, Chat apps, Community(Forum) apps, Shopping mall apps, and much more based on Firebase.

  • Complete features.
    This package has complete features (see Features below) that most of apps require.

  • Simple, easy and the right way.
    We want it to be deadly simple yet, right way for ourselves and for the developers in the world. We know when it gets complicated, our lives would get even more complicated.

  • Real time.
    We design it to be real time. All the events like post and comment creation, voting(like, dislike), deletion would appears on all the user's phone immediately after the event.

  • I am looking for community devleopers who can join this work. Please email me at thruthesky@gmail.com

Table of contents

TODOs #

Chat #

  • put many chat messages in one chat message box(balloon) if they are written in 20 minutes.

Installation #

Running the example #

Creating a new project #

Firebase installation #

iOS installation #

  • Download ios app's GoogleService-Info.plist. And save it under <root>/example/ios/Runnder, Then open Xcode and drag it under Runner.
    • Remember to update other settings like REVERSED_CLIENT_ID into Info.plist.
      • When you change the firebase project, you have to update all the related settings again.

Firebase Realtime Database Installation #

  • To install Firebase Realtime Database, enable it on Firebase console and put the security rules.

  • Note, if you enable Firebase Realtime Database, you have to re-download and update the GoogleService-Info.plist.

    • You may need to update the GoogleService-Info.plist after enabling other features of the Firebase.

  • Add the following security rules on firebase realtime database

{
  "rules": {
    "presence": {
      ".read": true,
      "$uid": {
        ".write": true
      }
    }
  }
}

Firestore installation #

  • Enable firestore.
  • Copy the firestore securiy rules and update it on your firebase project.
  • To install the firestore indexes, it is recommended to run the query and click the link of it to generate the indexes.
    • To do this, just call getFirestoreIndexLinks method and it will print the link on debug console. You just need to click the links.
    • See the firestore indexes and if you want to update it manually on your firebase project.

Setting admin on firestore security rules #

  • To set a user admin, Add the user's UID as field name(key) with the value of true in /settings/admin.
    • For instance, { "UID_AAA": true, "UID_BBB": true }, then users whose uid is UID_AAA and UID_BBB are the admins.

Security Rules Admin

User #

User installation #

  • Do Firebase installation
  • Enable Email/Password Sign-In method to login with email and password.
  • Enable Google Sign-In method and add the following in Info.plist to login with Google account
<!-- Google Sign-in Section -->
<key>CFBundleURLTypes</key>
<array>
	<dict>
		<key>CFBundleTypeRole</key>
		<string>Editor</string>
		<key>CFBundleURLSchemes</key>
		<array>
			<!-- TODO Replace this value: -->
			<!-- Copied from GoogleService-Info.plist key REVERSED_CLIENT_ID -->
			<string>com.googleusercontent.apps.------------------------</string>
		</array>
	</dict>
</array>
<!-- End of the Google Sign-in Section -->

Test users #

  • Create the following four test user accounts with password of 12345a.
    • apple@test.com, banana@test.com, cherry@test.com, durian@test.com

Phone number sign-in #

Phone Sign In UI

  • In most cases, you want to use Firebase Flutter UI for Firebase Sign-In and that's very fine. But with the Phone Sign-In built in UI, it's not easy to handle errors. So, fireflutter provides simple service for phone sign in.

  • To use phone sign-in, enable it. (and add some test phone numbers if you wish to test with test phone numbers.)

  • PhoneService has the service code of phone sign-in.

  • Fireflutter also provides UI widgets to make it easy to use in your app.

    • Simply add PhoneNumberInput widget to your screen and on code sent, move to sms code input page and add SmsCodeInput widget.
    • See example/lib/phone_sign_in_ui foler for sample code.

Email authentication under phone sign-in #

  • This email authentication under phone sign-in feature is only the case that the user logged in with phone sign-in. It may be used in other cases. But we consider the email authentication with phone sign-in only since we have phone sign-in service.

Email authentication under phone sign-in logic #

  • User presses email update button.

  • email update screen or popup will be opened where user can input his email.

  • user enter (or change) his email address and update it.

    • App updates email on google auth.
    • if user signed in long time ago, then there will be an exception of login again. If this exception happens, then remember the email address, and sign-in again.
    • Once signed in again, then update the email address again.
      • there might be another exception like 'email is in use'. then, warn user and let him enter new email address.

  • once email is updated, then verify it.

sub = Timder.periodic(Duraction(3 seconds), () {
  FirebaseAuth.instance.relaod();
  if ( FirebaseAuth.instance.currentUser.emailVerified == true ) {
    sub.cancel();
    go to home page.
  }
})

User presence #

User presence overview #

User Presence

  • More often, people want to know if their friends are online or not. Use this feature to know who is online. It has three status; 'online', 'offline', and 'away'.

User Presence Installation #

class _MainAppState extends State<MainApp> {
  @override
  void initState() {
    super.initState();
    Presence.instance.activate();
  }

  @override
  void dispose() {
    super.dispose();
    Presence.instance.activate(
      onError: (e) => print('--> Presence error: $e'),
    );
  }
}
  • To know if a user is online, offline or away, use UserPresence widget.
UserPresence(
  uid: uid,
  builder: (PresenceType type) => Row(
    children: [
      Icon(
        Icons.circle,
        color: type == PresenceType.online
            ? Colors.green
            : (type == PresenceType.offline ? Colors.red : Colors.yellow),
      ),
      Text(type.name),
    ],
  ),
),

User presence logic #

  • Run Presence.instance.activate() at start if you want to track the presence status of users.
  • If user didn't login to the device, the user will be offline by default.
  • If Presence is working, you will see the record in firebase realtime database data section in firebase console.
    • If no documents appears in firebase realtime database data section, then see the installation and issues.
  • /presense/$uid document will be written only when user logs in and out.
  • When app is closed, the user will be offline.

User profile #

  • Many apps share user name and photo. For instance, when a user chat to the other user, they shoud know each other's name and photo.

  • User name and photo are saved in /user/<uid> document of Firestore.

Displaying user profile #

  • To display a user profile(name or photo), Use UserDoc widget with the user's uid and you can build a widget based on the user profile.
    • The builder of UserDoc comes from a stream builder, which means when the user profile document changes, it will rebuild the builder widget to update realtime.
UserDoc(
  uid: user.uid,
  builder: (UserModel u) {
    return Row(
      children: [
        Text('name: ${u.name}'),
        Text(', profile: ${u.photoUrl}'),
      ],
    );
  },
),
  • To display a user profile, but only one time build (not automatic rebuild), use UserFutureDoc widget. The builder of UserFutureDoc is based on future builder. So, it does not rebuild even if the user profile document changes.
    • This widget may be used for forms. Like display user profile data in input fields.
UserFutureDoc(
  uid: user.uid,
  builder: (UserModel u) {
    return Row(
      children: [
        Text('name: ${u.name}'),
        Text(', profile: ${u.photoUrl}'),
      ],
    );
  },
),
  • Note, to display if the user is online or offline, see user presence.

User Auth State #

  • Build and display widgets based on user's auth state changes.
 AuthState(
   signedIn: (user) => Text('logged in'),
   signedOut: () => Text('logged out'),
   loader: Text('loading...'),
 ),

Chat #

Chat todo; #

  • when A enters a room with B, check if they are blocked. If yes, dispaly a warning.
  • when sending message fails, check if they are block and warn properly.
    • for instance, A request FriendMap to B, and A cannot send message to B since they are blocked. Then, display proper warning like "failed due to blocked" instead of meaning less message like "failed or permission denied."

Chat structure of Firestore #

  • /chat/messages/<uid>__<uid> is the collection of a chat room messages. Each document in this collection is the chat message documents that are handled by the ChatMessageModel. This is called message doc.

  • /chat/rooms/<uid> is the collection of a user's chat friends. The documents inside this collection are the users that he chatted. For instance,

    • /chat/rooms/<uid>/<uid> is the document of a chat room. This document has the room information. (This is called room info doc.) For instance,
      • /chat/room/A/B
      • /chat/room/A/C Then, the user A have had chat with user B and C. Note that, room info doc is also handled by the ChatMessageModel.

Chat logic #

  • If it needs a speed to work, then just rely on the security rules without check permission before action.

    • For instance, when A sends a message to B, it needs a speed. So, don't check if A is allowed to send message to B before it fails.
      • Once it fails to send the message, then check what causes the problem.

  • If it does not need speed, then the app may check permission first.

    • For instance, blocking a user does not need a speed. so, the app can check if the user can be blocked before it fails by security rules.

Chat logic - block #

  • Setting blocked properties in room info doc - /chat/rooms/<uid>/<uid>.blocked: true is not working deu to the inequality feature of Firestore.

    • You can order by timestamp where blocked == true. It's against inequality rule.

  • To solve this,

    • remove blocked user's room info from /chat/rooms/<my>/<other>
    • save user uid at /chat/blocked/<my>/<other>.timestamp.

  • When A blocked to B, both cannot send message to each other.

Reminder #

Reminder

  • ReminderService is to remind some to users with custom UI.

    • When the app has some to remind its users, push notification may be one option.
      • But push notification does not deliver reminders to the users who registered after sending notifications.
      • And it does not have an option like 'remind me later`.
    • ReminderService can do this.

  • It uses /settings/reminder document.

    • It is not recommended to edit the docuement directly insdie firebase console.

  • ReminderEdit widget is a sample code for updating the document. you can customize by copy & paste.

  • And ReminderService.instance.display() is the default UI to display reminder on app screen. You can also customize the UI by copy & paste.

Reminder code sample #

  • To display reminder dialog when there is a reminder, use the code below.
/// Define global key somewhere.
final GlobalKey<NavigatorState> navigatorKey = GlobalKey();


/// Apply it to MaterialApp.
class _MainAppState extends State<MainApp> {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
            navigatorKey: navigatorKey,
          );
  }
}

/// Listen to reminder
///
/// Delay 3 seconds. This is just to display the reminder dialog 3 seconds
/// after the app boots. No big deal here.
Timer(const Duration(seconds: 3), () {
  /// Listen to the reminder update event.
  ReminderService.instance.listen((reminder) {
    /// Display the reminder using default dialog UI. You may copy the code
    /// and customize by yourself.
    ReminderService.instance.display(
      /// Use the global NavigatorState to display dialog.
      context: navigatorKey.currentContext!,
      data: reminder,
      onLinkPressed: (page, arguments) {
        Get.toNamed(page, arguments: arguments);
      },
    );
  });
});

  • For updating, reminder, see the sample come of ReminderEditScreen.

  • To update imageUrl outside of ReminderEdit widget, use the controller.

final controller = ReminderEditController();
ReminderEdit(
  controller: controller,
  // ...
);

// ...
controller.updateImageUrl('http://new-image-url.jpg');

Reminder logic #

  • There are title, content, imageUrl, link fields on the form.

  • One of title, content, imageUrl must have value or dialog will not appear.

  • link has the information to which screen the app should move once user pressed on more info button. It must not be an empty string.

    • When more info button is pressed, ReminderService saves the link on local storage and calls the callback, then app can move the screen.
      • And when the app start again, it will not get the reminder document again from firestore since the link has already opened.
    • When user pressed on don't show again button, the link will be saved on local storage and when the app starts again, it will not get the reminder document again from firestore.
    • When remind me later button clicked, the app simply closes the dialog and when the app starts again, the app will fetch the reminder doc from firestore and display the reminder dialog again on screen.
    • When backdrop had touched, the app works the same as remind me later button pressed.
    • link can have in URL format. For instance, /post-view?postId=123&option=a. And when callback is being called /post-view parts goes to first parameter, and {'postId': 123, 'option': a} goes to next parameter.
      • If link changes, the ReminderService considers as a new link had been activated.
      • So, if you want to display a reminder dialog again with same url, then you may simply change the parameter a little like /post-view?postId=123&option=b.
    • Once link is saved on local storage, ReminderService does not get the same document of link again from firestore.

  • The default dialog UI has three buttons.

    • more info, don't show again, and remind me later.
    • User can press on backdrop and it work just as reminde me later button.

  • There are three buttons on ReminderEdit widget. You can update the /settings/reminder document with it.

    • When you press preview button, you can see the look of the default dialog UI with the reminder data.

      • When you press don't show again button on preview UI dialog, it saves the link on local storage.
      • When you press more info button button on preview UI dialog, it saves the link on local storage and calls the callback where the app can move to the intended screen.
      • Since the link saved, when the app restarts the reminder dialog would not appear.
      • One fitfall is that, when app starts, ReminderService will listen to the /settings/reminder with the link saved previously. and don't show again or more info button is pressed on preview mode. Then, new link had been saved on local storage. the but new link is not the same link that app is listening to. So, when save button pressed, the reminder dialog would popup.

    • When you edit and preview, you may add a version (test) value to see the changes.

      • For instance, /post-view?postId=123&version=456.

    • When you press on preview, it does not save the form data into reminder doc in firestore. So, you have to press save button to update the reminder doc. And then the updated reminder doc will be downloaded to users' app and reminder UI appears on all the online users' devices.

    • You may have an image upload button and update imageUrl with the uploaded image. But for now, you can input the imageUrl on the imageUrl field.

  • Only admin whose UID is set in /settings/admin can edit the reminder documents.

  • There is no fixed size of the image of imageUrl. The recommended size would be maximum of 512px width and the ratio of the width 3 and height 2.

  • If admin updates the reminder with changes of link very quickly like 2 times in a minute, then two popup may appear on user's screen. This won't be happening in production mode and won't be a big trouble.

FriendMap #

  • Idea
    When someone is seeking someone and both of them are foreginers of the place, how would they find each other? Both of them do not understand the country's language. FriendMap feature send a user's latitude and longitude to the other user. So the other can navigate on the map.

FriendMap installation #

  • Follow the installation instructions in google_maps_flutter package.

    • Hybrid Composition could be an option.

  • Follow the installation instructions in geocoding package.

  • Follow the installation in geolocator package.

FriendMap logic #

  • There are two users. User A and B.

  • A sends his latitude and longitude to B on chat. (So, when B is offline, he will get push notification by the built in chat funciton)

  • B opens chat room.

  • B click the link of lat & lon to open Friend Map.

  • the app navigates.

FriendMap informing logic #

  • Use Inform feature to inform friend request to the other user.

FriendMap testing #

  • Simply update /location/<A's-uid>/ and /location/<B's-uid> manully.
    • To make it easy, update the location programatically.

Inform #

  • When A likes B's post, how the app will inform B that he has a like from A?
    • Push notification is one option. But push notification may be delayed more than 1 hour.
    • Inform functionality make the communication in realtime.

Informing logic #

Let's say the app needs to deliver friend request from A to B.

  • When User A request FriendMap to user B, it's not easy to open FriendMap by clicking the chat message. what if user B has lots of users and having difficulty to open the chat room A?.

    • The solution would be; when A request FriendMap to B, the app on B side will open FriendMap screen automatically.
    • When B is offline and got a push message of FriendMap request, the device of B will automatically run WonderfulKorea app and open FriendMap screen automatically.
    • Later; it may be an option to open FriendMap automatically or not.

  • To make it work

    • All user must listen to /inform/<uid> when app starts.
    • When A request FriendMap to B, save lat & long in /inform/<uid>.
    • So, the app of B can open FriendMap with the data.

  • When B is offline, or the app is not running,

    • B will open the app (by push notification or whatever),
    • the app of B listens /inform/<uid>
      • If there is data, then delete the doc, and open FriendMap.

Inform data #

  • type has the data type.
    • FriendMap - it's a data for FriendMap and latitude and longitude properties are found.
    • type can be customizable and can have any value and addition properties.

Use of inform #

  • To start listening the inform data, call InformService.instance.init(callback: (data) {}).
FirebaseAuth.instance.authStateChanges().listen((user) {
  if (user != null) {
    /// Re-init for listening the login user (when account changed)
    InformService.instance.init(callback: (data) {
      if (data['type'] == 'FriendMap') {
        /// If it's a freind map request, then open friend map screen.
        Get.toNamed('/friend-map', arguments: {
          'latitude': data['latitude'],
          'longitude': data['longitude'],
        });
      }
    });
  } else {
    InformService.instance.dispose();
  }
});
  • When the app needs to inform to other user, call InformService.instance.inform(<uid>, {...data....}).
InformService.instance.inform(widget.room.otherUid, {
  'type': 'FriendMap',
  'latitude': pos.latitude,
  'longitude': pos.longitude,
});

For developer #

Building your app #

  • To build your app with firelutter, simply add it on pubspec dependency.

Building fireflutter #

  • Follow the steps
    • fork
    • clone
    • create a branch
    • update fireflutter
    • push
    • pull request.

Updating fireflutter while building your app #

  • If you are going to use fireflutter, then simply add it on pubspec dependency.
  • If you want to build fireflutter while you are building your app, then
    • fork fireflutter
    • add it as submodule in your project
    • add it as pubspec dependency with local path
    • when ever you want to update fireflutter, simple run <submodule-folder>/example/main.dart
    • after updating fireflutter, come back to your app and run your app.

Test #

Local test on firestore security rules #

  • We have local unit test for firestore security rules at <root>/firebase/test folder.

  • To run the test,

    • open <root>/firebase/test/test.js and update TEST_PROJECT_ID to your firebase project id.
    • run $ firebase emulators:start under <root>/firebase folder.
    • run $ npm test under <root>/firebase/test folder.

  • To deploy,

    • open <root>/firebase/.firebaserc and update projects.default to your firebase project id.
    • run $ firebase deploy --only firestore

Issues #

  • These are the common issues you may encount working this package.
  • If you have any issues, please create an git issue.

firebase_database/permission-denied #

Unhandled Exception: [firebase_database/permission-denied] Client doesn't have permission to access the desired data.

Firebase realtime database is not working #

  • Open GoogleService-Info.plist under ios/Runner and see if the key DATABASE_URL is present. If not, enable firebase realtime database and download the GoogleService-Info.plist again. Remember to update related settings once you download it again.

firebase_auth/internal-error #

If you see this error message while working with Firebase Auth, check the followings;

  • Check if REVERSE_CLIENT_ID is set on iOS.
  • Check if GCP credential is properly set iOS.

← Metadata

154
likes
0
pub points
70%
popularity

Publisher

verified publishersonub.com

Metadata

A free, open source, complete, rapid development package for creating Social apps, Chat apps, Community(Forum) apps, Shopping mall apps, and much more based on Firebase.

Repository (GitHub)
View/report issues

License

unknown (LICENSE)

Dependencies

badges, cloud_firestore, country_code_picker, firebase_auth, firebase_core, firebase_database, flutter, flutter_polyline_points, geocoding, geolocator, google_maps_flutter, paginate_firestore, rxdart, shared_preferences

More

Packages that depend on fireflutter

Back