Repository files navigation

Firebase Compose is an Open Source library for Android that allows you toquickly connect a Jetpack Compose app toFirebase APIs.

1. Usage
2. Installation
3. Dependencies
   1. Compatibility
4. Sample App
5. Contributing
6. License
7. Acknowledgment

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

• Firebase Compose Firestore
• Firebase Compose Database

Firebase Compose is published as a collection of libraries separated by theFirebase API they target. Each Firebase Compose library has a transitivedependency on the appropriate Firebase SDK so there is no need to includethose separately in your app.

Step 1 - Add the jitpack maven in your rootbuild.gradle at the end of repositories:

allprojects {        repositories {...            maven { url'https://jitpack.io' }        }    }

Step 2 - In yourapp/build.gradle file add a dependency on one of the Firebase Composelibraries.

dependencies {// Firebase Compose for Firebase Realtime Database    implementation'com.github.rosariopfernandes.firebase-compose:database:1.0.0-beta01'// Firebase Compose for Cloud Firestore    implementation'com.github.rosariopfernandes.firebase-compose:firestore:1.0.0-beta01'}

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

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

firebase-compose:database|--- com.google.firebase:firebase-database-ktxfirebase-compose:firestore|--- com.google.firebase:firebase-firestore-ktx

A sample app is available in thedemo directory.

Anyone and everyone is welcome to contribute. Please take a moment toreview thecontributing guidelines.

This project is licensed under the MIT License - see theLICENSE file for details.

README files inspired byFirebaseUI