Bikram40 / firebase_messageing_web

firebase_messaging_web

This repository contains the web implementation of firebase_messaging, a modified version of the official Firebase Messaging plugin for Flutter web applications.

Introduction

Firebase Cloud Messaging (FCM) is a cloud solution for messages on iOS, Android, and web applications. It provides a reliable and efficient connection between the server and devices that allow server applications to send messages to the client.

This modified web implementation offers enhanced functionality over the official Firebase Messaging plugin for web.

Advantages of this Implementation:

1. Support for Background Messages: This plugin supports onBackgroundMessages even when the browser is in background mode, a feature not available in the official plugin.

2. One-Time Initialization: With this plugin, you need to create a firebase-config.js file with your Firebase configuration. Example:

   const firebaseConfig = {
      apiKey: "YOUR_API_KEY",
      authDomain: "YOUR_AUTH_DOMAIN",
      projectId: "YOUR_PROJECT_ID",
      storageBucket: "YOUR_STORAGE_BUCKET",
      messagingSenderId: "YOUR_MESSAGING_SENDER_ID",
      appId: "YOUR_APP_ID",
      measurementId: "YOUR_MEASUREMENT_ID"
   };

   In contrast, the official plugin requires multiple files like firebase-messaging-sw.js with embedded credentials.

   Add Firebase: Please add below code on your web/index.html

   <script src="https://www.gstatic.com/firebasejs/9.17.1/firebase-app-compat.js"></script>
   <script src="https://www.gstatic.com/firebasejs/9.17.1/firebase-messaging-compat.js"></script>

3. Flexible File Location: The official plugin mandates the firebase-messaging-sw.js to reside at the root of the domain. Our implementation removes this constraint.

4. Future Enhancements: Plans are underway to add callbacks like onMessageOpenedApp and methods like getInitialMessage.

Alright, if you're guiding developers to override the dependency using the dependency_overrides section in their pubspec.yaml file, the instructions should reflect that.

Here's the revised section to guide developers on using the dependency_overrides for your firebase_messaging_web plugin:

---

Using this Plugin in Your Project

To ensure that the enhanced version of firebase_messaging_web from this repository is used in your Flutter web application, you will need to override the dependency in your pubspec.yaml file. Add or modify the dependency_overrides section as follows:

dependency_overrides:
  firebase_messaging_web:
    git:
      url: https://github.com/Bikram40/firebase_messageing_web.git

By adding this section, the Flutter package manager (pub) will prioritize this repository's version of firebase_messaging_web over any other referenced version in your project.

---