Optimized UI components for Firebase
Switch branches/tags
Clone or download
btrautmann and samtstern Update README.md (#1506)
Kotlin users will need to use `kapt` instead of `annotationProcessor` or `GlideApp` will not be generated. Could be a bit clearer with this comment in the docs.
Latest commit 3e7fb9e Oct 28, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Massive docs cleanup and structure clarification (#1078) Jan 2, 2018
.idea Style refactor (#784) Jul 5, 2017
.opensource Update project.json Oct 1, 2018
app Fix landscape NASCAR layout (#1460) Sep 27, 2018
auth-github Fix small issues left in version 4.2.1 (#1495) Oct 24, 2018
auth Version 4.2.1 Oct 24, 2018
buildSrc Version 4.2.1 Oct 24, 2018
common Add nullability annotations to all modules except for auth Aug 28, 2018
database Add nullability annotations to all modules except for auth Aug 28, 2018
doc-images Update picture to display correct Chat model Apr 27, 2017
docs Translations for continue as guest (#1390) Jul 9, 2018
firestore Publicly usable lint checks (#1427) Sep 4, 2018
gradle/wrapper Fix more incorrect API usages Aug 27, 2018
internal Publicly usable lint checks (#1427) Sep 4, 2018
library Optimize build performance Aug 27, 2018
lint Publicly usable lint checks (#1427) Sep 4, 2018
proguard-tests Stabilize Build (#1463) Sep 26, 2018
scripts Remove unused resources May 22, 2018
storage Update README.md (#1506) Oct 28, 2018
.gitignore Update and fix deps (#756) Jun 15, 2017
.travis.yml Stabilize Build (#1463) Sep 26, 2018
LICENSE License change, adding META Sep 3, 2015
README.md Version 4.2.1 Oct 24, 2018
build.gradle Fix small issues left in version 4.2.1 (#1495) Oct 24, 2018
build.gradle.kts Add nullability annotations to all modules except for auth Aug 28, 2018
gradle.properties Optimize build performance Aug 27, 2018
gradlew Update and fix deps (#756) Jun 15, 2017
gradlew.bat Update gradlew scripts Dec 2, 2016
settings.gradle Fix small issues left in version 4.2.1 (#1495) Oct 24, 2018

README.md

FirebaseUI for Android — UI Bindings for Firebase

FirebaseOpensource.com Build Status

FirebaseUI is an open-source library for Android that allows you to quickly connect common UI elements to Firebase APIs.

A compatible FirebaseUI client is also available for iOS.

Table of contents

  1. Usage
  2. Installation
    1. Upgrading
  3. Dependencies
    1. Compatability
    2. Upgrading dependencies
  4. Sample App
  5. Snapshot Builds
  6. Contributing
    1. Installing
    2. Deploying
    3. Tagging
    4. License agreements
    5. Process

Usage

FirebaseUI has separate modules for using Firebase Realtime Database, Cloud Firestore, Firebase Auth, and Cloud Storage. To get started, see the individual instructions for each module:

Installation

FirebaseUI is published as a collection of libraries separated by the Firebase API they target. Each FirebaseUI library has a transitive dependency on the appropriate Firebase SDK so there is no need to include those separately in your app.

In your app/build.gradle file add a dependency on one of the FirebaseUI libraries.

dependencies {
    // FirebaseUI for Firebase Realtime Database
    implementation 'com.firebaseui:firebase-ui-database:4.2.1'

    // FirebaseUI for Cloud Firestore
    implementation 'com.firebaseui:firebase-ui-firestore:4.2.1'

    // FirebaseUI for Firebase Auth
    implementation 'com.firebaseui:firebase-ui-auth:4.2.1'

    // FirebaseUI for Firebase Auth (GitHub provider)
    implementation 'com.firebaseui:firebase-ui-auth-github:4.2.1'

    // FirebaseUI for Cloud Storage
    implementation 'com.firebaseui:firebase-ui-storage:4.2.1'
}

If you're including the firebase-ui-auth dependency, there's a little more setup required.

After the project is synchronized, we're ready to start using Firebase functionality in our app.

Upgrading

If you are using an old version of FirebaseUI and upgrading, please see the appropriate migration guide:

Dependencies

Compatibility with Firebase / Google Play Services libraries

FirebaseUI libraries have the following transitive dependencies on the Firebase SDK:

firebase-ui-auth
|--- com.google.firebase:firebase-auth
|--- com.google.android.gms:play-services-auth

firebase-ui-database
|--- com.google.firebase:firebase-database

firebase-ui-firestore
|--- com.google.firebase:firebase-firestore

firebase-ui-storage
|--- com.google.firebase:firebase-storage

As of version 15.0.0, Firebase and Google Play services libraries have independent, semantic versions. This means that FirebaseUI has independent dependencies on each of the libraries above. For best results, your app should depend on a version of each dependency with the same major version number as the version used by FirebaseUI.

As of version 4.2.1, FirebaseUI has the following dependency versions:

Library Version
firebase-auth 16.0.5
play-services-auth 16.0.1
firebase-database 16.0.3
firebase-firestore 17.1.1
firebase-storage 16.0.3

Upgrading dependencies

If you would like to use a newer version of one of FirebaseUI's transitive dependencies, such as Firebase, Play services, or the Android support libraries, you need to add explicit implementation declarations in your build.gradle for all of FirebaseUI's dependencies at the version you want to use. For example if you want to use Play services/Firebase version FOO and support libraries version BAR add the following extra lines for each FirebaseUI module you're using:

Auth

implementation "com.google.firebase:firebase-auth:$FOO"
implementation "com.google.android.gms:play-services-auth:$FOO"

implementation "com.android.support:design:$BAR"
implementation "com.android.support:customtabs:$BAR"
implementation "com.android.support:cardview-v7:$BAR"

Firestore

implementation "com.google.firebase:firebase-firestore:$FOO"

implementation "com.android.support:recyclerview-v7:$BAR"
implementation "com.android.support:support-v4:$BAR"

Realtime Database

implementation "com.google.firebase:firebase-database:$FOO"

implementation "com.android.support:recyclerview-v7:$BAR"
implementation "com.android.support:support-v4:$BAR"

Storage

implementation "com.google.firebase:firebase-storage:$FOO"

implementation "com.android.support:appcompat-v7:$BAR"
implementation "com.android.support:palette-v7:$BAR"

Note

Starting version 25.4.0, support libraries are now available through Google's Maven repository, so ensure that you have that added to your project's repositories.

Open the build.gradle file for your project and modify it as following,

allprojects {
    repositories {
        google()
        jcenter()
    }
}

Sample app

There is a sample app in the app/ directory that demonstrates most of the features of FirebaseUI. Load the project in Android Studio and run it on your Android device to see a demonstration.

Before you can run the sample app, you must create a project in the Firebase console. Add an Android app to the project, and copy the generated google-services.json file into the app/ directory. Also enable anonymous authentication for the Firebase project, since some components of the sample app requires it.

If you encounter a version incompatibility error between Android Studio and Gradle while trying to run the sample app, try disabling the Instant Run feature of Android Studio. Alternatively, update Android Studio and Gradle to their latest versions.

A note on importing the project using Android Studio: Using 'Project from Version Control' will not automatically link the project with Gradle (issue #1349). When doing so and opening any build.gradle.kts file, an error shows up: Project 'FirebaseUI-Android' isn't linked with Gradle. To resolve this issue, please git checkout the project manually and import with Import from external model.

Snapshot builds

Like to live on the cutting edge? Want to try the next release of FirebaseUI before anyone else? As of version 3.2.2 FirebaseUI hosts "snapshot" builds on oss.jfrog.org.

Just add the following to your build.gradle:

repositories {
  maven { url "https://oss.jfrog.org/artifactory/oss-snapshot-local" }
}

Then you can depend on snapshot versions:

implementation 'com.firebaseui:firebase-ui-auth:x.y.z-SNAPSHOT'

You can see which SNAPSHOT builds are avaiable here: https://oss.jfrog.org/webapp/#/artifacts/browse/tree/General/oss-snapshot-local/com/firebaseui

Snapshot builds come with absolutely no guarantees and we will close any issues asking to troubleshoot a snapshot report unless they identify a bug that should block the release launch. Experiment at your own risk!

Contributing

Installing locally

You can download FirebaseUI and install it locally by cloning this repository and running:

./gradlew :library:prepareArtifacts :library:publishAllToMavenLocal

Deployment

To deploy FirebaseUI to Bintray

  1. Set BINTRAY_USER and BINTRAY_KEY in your environment. You must be a member of the firebaseui Bintray organization.
  2. Run ./gradlew clean :library:prepareArtifacts :library:bintrayUploadAll
  3. Go to the Bintray dashboard and click 'Publish'.
    1. In Bintray click the 'Maven Central' tab and publish the release.

Tag a release on GitHub

  • Ensure that all your changes are on master and that your local build is on master
  • Ensure that the correct version number is in common/constants.gradle

Contributor License Agreements

We'd love to accept your sample apps and patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

Contribution process

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork the desired repo, develop, and then test your code changes on the latest dev branch.
  5. Ensure that your code adheres to the existing style of the library to which you are contributing.
  6. Ensure that your code has an appropriate set of unit tests which all pass.
  7. Submit a pull request targeting the latest dev branch.