FirebaseUI-Android

# FirebaseUI for Android — UI Bindings for Firebase

[![FirebaseOpensource.com](https://img.shields.io/badge/Docs-firebaseopensource.com-orange.svg)](
https://firebaseopensource.com/projects/firebase/firebaseui-android
)
[![Actions Status][gh-actions-badge]][gh-actions]

FirebaseUI is an open-source library for Android that allows you to
quickly connect common UI elements to [Firebase](https://firebase.google.com) APIs.

A compatible FirebaseUI client is also available for [iOS](https://github.com/firebase/firebaseui-ios).

## Table of contents

1. [Usage](#usage)
1. [Installation](#installation)
   1. [Upgrading](#upgrading)
1. [Dependencies](#dependencies)
   1. [Compatibility](#compatibility-with-firebase--google-play-services-libraries)
   1. [Upgrading dependencies](#upgrading-dependencies)
1. [Sample App](#sample-app)
1. [Snapshot Builds](#snapshot-builds)
1. [Contributing](#contributing)
   1. [Installing](#installing-locally)
   1. [License agreements](#contributor-license-agreements)
   1. [Process](#contribution-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:

* [FirebaseUI Auth](auth/README.md)
* [FirebaseUI Firestore](firestore/README.md)
* [FirebaseUI Database](database/README.md)
* [FirebaseUI Storage](storage/README.md)

## 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.

```groovy
dependencies {
    // FirebaseUI for Firebase Realtime Database
    implementation 'com.firebaseui:firebase-ui-database:10.0.0-beta05'

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

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

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

If you're including the `firebase-ui-auth` dependency, there's a little
[more setup](auth/README.md#configuration) 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:

* [Upgrade from 9.1.1 to 10.x.x](./docs/upgrade-to-10.0.md)
* [Upgrade from 8.0.2 to 9.x.x](./docs/upgrade-to-9.0.md)
* [Upgrade from 7.2.0 to 8.x.x](./docs/upgrade-to-8.0.md)
* [Upgrade from 6.4.0 to 7.x.x](./docs/upgrade-to-7.0.md)
* [Upgrade from 5.1.0 to 6.x.x](./docs/upgrade-to-6.0.md)
* [Upgrade from 4.3.2 to 5.x.x](./docs/upgrade-to-5.0.md)
* [Upgrade from 3.3.1 to 4.x.x](./docs/upgrade-to-4.0.md)
* [Upgrade fro