An RxJava2 wrapper for Cloud Firestore
Clone or download
btrautmann Merge pull request #15 from ofalvai/observable-add
Adding documents with Single<DocumentReference> besides Completable
Latest commit 0c47082 Nov 27, 2018

README.md

Download

CircleCI

RxFirestore

RxFirestore is an RxJava2 wrapper for Cloud Firestore, which is a new database solution by Firebase and is currently in beta. It provides a more friendly API than that of Firestore itself for those familiar with RxJava. Check out the RxFirestore docs for more information on the API.

How to use it:

RxFirestore is currently on Jcenter, so you can simple add the implementation statements (if on Android Gradle Plugin 3.0+, use compile otherwise)

Java:

  • Add implementation statement in your app module's build.gradle:
implementation 'com.oakwoodsc.rxfirestore:rxfirestore:${latestVersion}'

Kotlin:

  • Add implementation statement in your app module's build.gradle:
implementation 'com.oakwoodsc.rxfirestore:rxfirestore:${latestVersion}'
implementation 'com.oakwoodsc.rxfirestore:rxfirestorekt:${latestVersion}'

Current Status: In Development

Currently developed with:

  • Firestore 17.1.2
  • RxJava 2.2.3

Contributions welcome

I won't be working on this full-time, rather fast enough to support my own needs. With that said, please feel free to contribute as much as you'd like. Tests are encouraged (though there are none yet).

Thank You

Thank you in advance to kunny for his RxFirebase database implementation, as I'll be mainly porting that to support Cloud Firestore.