dheia / wn-firebase-plugin

WinterCMS plugin for easy Firebase setup

Firebase for WinterCMS

A WinterCMS plugin for the Firebase for Laravel package.

• Installation
• Configuration
  • Service account
• Usage
• Support
• License

Installation

First install the plugin with composer:

composer require norotaro/wn-firebase-plugin

Then run the migration files with:

php artisan winter:up

Configuration

This plugin provides a web interface to configure the original Laravel package, the settings set in this form override the package settings.

You can configure the package without the web interface provided by this plugin following the instructions of the package.

Any configuration saved in the web interface will override the package configuration.

Service account

In order to access a Firebase project and its related services using a server SDK, requests must be authenticated. For server-to-server communication this is done with a Service Account.

If you don't already have generated a Service Account, you can do so by following the instructions from the official documentation pages at https://firebase.google.com/docs/admin/setup#initialize_the_sdk.

Usage

As specified in the original package:

Component	Automatic Injection	Facades	app()
Authentication	\Kreait\Firebase\Auth	Firebase::auth()	app('firebase.auth')
Cloud Firestore	\Kreait\Firebase\Firestore	Firebase::firestore()	app('firebase.firestore')
Cloud Messaging (FCM)	\Kreait\Firebase\Messaging	Firebase::messaging()	app('firebase.messaging')
Dynamic Links	\Kreait\Firebase\DynamicLinks	Firebase::dynamicLinks()	app('firebase.dynamic_links')
Realtime Database	\Kreait\Firebase\Database	Firebase::database()	app('firebase.database')
Remote Config	\Kreait\Firebase\RemoteConfig	Firebase::remoteConfig()	app('firebase.remote_config')
Cloud Storage	\Kreait\Firebase\Storage	Firebase::storage()	app('firebase.storage')

Once you have retrieved a component, please refer to the documentation of the Firebase PHP Admin SDK for further information on how to use it.

You don't need and should not use the new Factory() pattern described in the SDK documentation, this is already done for you with the Laravel Service Provider. Use Dependency Injection, the Facades or the app() helper instead

Suport

• Issue Tracker (WinterCMS Plugin)
• Issue Tracker (Laravel Package)
• Bug Reports (Admin SDK)
• Feature Requests and Discussions (Admin SDK)
• Stack Overflow

License

Firebase for WinterCMS is licensed under the MIT License.

Your use of Firebase is governed by the Terms of Service for Firebase Services.