react-native-firebase/docs/installation-android.md

Android Installation

1) Setup google-services.json

Download the google-services.json file provided by Firebase in the Add Firebase to Android platform menu in your Firebase configuration console. This file should be downloaded to YOUR_PROJECT/android/app/google-services.json.

Next you'll have to add the google-services gradle plugin in order to parse it.

Add the google-services gradle plugin as a dependency in the project level build.gradle android/build.gradle

buildscript {
  // ...
  dependencies {
    // ...
    classpath 'com.google.gms:google-services:3.0.0'
  }
}

In your app build.gradle file, add the gradle plugin at the VERY BOTTOM of the file (below all dependencies) android/app/build.gradle

apply plugin: 'com.google.gms.google-services'

2) Link RNFirebase

RNFirebase is split into separate modules to allow you to only include the Firebase functionality that you need in your application.

First add the project path to android/settings.gradle:

include ':react-native-firebase'
project(':react-native-firebase').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-firebase/android')

Now you need to include RNFirebase and the required Firebase dependencies in our android/app/build.gradle so that they are compiled as part of React Native. In the dependencies listing, add the appropriate compile lines:

dependencies {
  // RNFirebase required dependencies
  compile(project(':react-native-firebase')) {
    transitive = false
  }
  compile "com.google.firebase:firebase-core:11.2.0"

  // If you are receiving Google Play API availability issues, add the following dependency
  compile "com.google.android.gms:play-services-base:11.2.0"

  // RNFirebase optional dependencies
  compile "com.google.firebase:firebase-ads:11.2.0"
  compile "com.google.firebase:firebase-auth:11.2.0"
  compile "com.google.firebase:firebase-config:11.2.0"
  compile "com.google.firebase:firebase-crash:11.2.0"
  compile "com.google.firebase:firebase-database:11.2.0"
  compile "com.google.firebase:firebase-firestore:11.2.0"
  compile "com.google.firebase:firebase-messaging:11.2.0"
  compile "com.google.firebase:firebase-perf:11.2.0"
  compile "com.google.firebase:firebase-storage:11.2.0"
}

Google Play services from 11.2.0 onwards require their dependencies to be downloaded from Google's Maven respository so add the required reference to the repositories section of the project level build.gradle android/build.gradle

allprojects {
    repositories {
         // ...
        maven {
            url 'https://maven.google.com'
        }
    }
}

To install react-native-firebase in your project, you'll need to import the packages you need from io.invertase.firebase in your project's android/app/src/main/java/com/[app name]/MainApplication.java and list them as packages for ReactNative in the getPackages() function:

package com.youcompany.application;
// ...
// Required package
import io.invertase.firebase.RNFirebasePackage; // <-- Add this line
// Optional packages - add as appropriate
import io.invertase.firebase.admob.RNFirebaseAdMobPackage; //Firebase AdMob
import io.invertase.firebase.analytics.RNFirebaseAnalyticsPackage; // Firebase Analytics
import io.invertase.firebase.auth.RNFirebaseAuthPackage; // Firebase Auth
import io.invertase.firebase.config.RNFirebaseRemoteConfigPackage; // Firebase Remote Config
import io.invertase.firebase.crash.RNFirebaseCrashPackage; // Firebase Crash Reporting
import io.invertase.firebase.database.RNFirebaseDatabasePackage; // Firebase Realtime Database
import io.invertase.firebase.firestore.RNFirebaseFirestorePackage; // Firebase Firestore
import io.invertase.firebase.messaging.RNFirebaseMessagingPackage; // Firebase Cloud Messaging
import io.invertase.firebase.perf.RNFirebasePerformancePackage; // Firebase Performance
import io.invertase.firebase.storage.RNFirebaseStoragePackage; // Firebase Storage
// ...
public class MainApplication extends Application implements ReactApplication {
    // ...

    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
          new MainReactPackage(),
          new RNFirebasePackage(),  // <-- Add this line
          // Add these packages as appropriate
          new RNFirebaseAdMobPackage(),
          new RNFirebaseAnalyticsPackage(),
          new RNFirebaseAuthPackage(),
          new RNFirebaseRemoteConfigPackage(),
          new RNFirebaseCrashPackage(),
          new RNFirebaseDatabasePackage(),
          new RNFirebaseFirestorePackage(),
          new RNFirebaseMessagingPackage(),
          new RNFirebasePerformancePackage(),
          new RNFirebaseStoragePackage()
      );
    }
  };
  // ...
}

3) Cloud Messaging (optional)

If you plan on using Firebase Cloud Messaging, add the following to android/app/src/main/AndroidManifest.xml.

Add permissions:

<manifest ...>
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
  <uses-permission android:name="android.permission.VIBRATE" />

Set app launch mode inside activity props:

<activity
  ...
  android:launchMode="singleTop"
>

Add messaging service:

<application ...>
  <service
    android:name="io.invertase.firebase.messaging.MessagingService"
    android:enabled="true"
    android:exported="true">
      <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
      </intent-filter>
  </service>
  <service android:name="io.invertase.firebase.messaging.InstanceIdService" android:exported="false">
    <intent-filter>
      <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
    </intent-filter>
  </service>

If you would like to schedule local notifications then you also need to add the following:

  <receiver android:name="io.invertase.firebase.messaging.RNFirebaseLocalMessagingPublisher"/>
  <receiver android:enabled="true" android:exported="true" android:name="io.invertase.firebase.messaging.RNFirebaseSystemBootEventReceiver">
    <intent-filter>
      <action android:name="android.intent.action.BOOT_COMPLETED"/>
      <action android:name="android.intent.action.QUICKBOOT_POWERON"/>
      <action android:name="com.htc.intent.action.QUICKBOOT_POWERON"/>
      <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>
  </receiver>

4) Performance Monitoring (optional)

If you'd like to take advantage of Firebase's Performance Monitoring, the following additions to your project setup are required:

In your projects android/build.gradle file, add the plugin to your dependencies:

dependencies {
  // ...
  classpath 'com.google.firebase:firebase-plugins:1.1.0'
}

At the top of your android/app/build.gradle file, below other plugins, apply the firebase-perf plugin:

apply plugin: "com.android.application"
apply plugin: "com.google.firebase.firebase-perf"

In the same file, add the firebase-perf module to your dependencies:

dependencies {
  // ...
  compile "com.google.firebase:firebase-perf:11.2.0"
}