Skip to content

Latest commit

 

History

History
118 lines (93 loc) · 13.5 KB

README.md

File metadata and controls

118 lines (93 loc) · 13.5 KB


React Native Firebase

NPM downloads NPM version License Maintained with Lerna

Chat on Discord Follow on Twitter


WARNING: Master branch is the work in progress v6.0.0 version of React Native Firebase, you're probably looking for the current v5.x.x branch instead, please send all PRs for the live version to that branch. You can learn more about this here.


React Native Firebase is a collection of official React Native modules connecting you to Firebase services; each module is a light-weight javascript layer connecting you to the native Firebase SDKs for both iOS and Android.

React Native Firebase is built with four key principals in mind;

  • 🧪 Well tested
    • every module is extensively tested to >95% coverage
  • 👁 Well typed
    • first class support for both Flow & Typescript included
  • 📄 Well documented
    • full reference & installation documentation alongside detailed guides and FAQs
  • 🔥 Mirrors official Firebase Web SDK
    • functions as a drop-in replacement for the Firebase Web SDK in React Native
    • maximises cross-platform code re-usability e.g. re-using code on web platforms

Firebase Modules

This is the root of the monorepo for React Native Firebase, if you're looking for a specific package please select the package link from below.

The main package that you interface with is App (@react-native-firebase/app)

Name Downloads Coverage
AdMob badge badge
Analytics badge badge
App badge badge
App Indexing badge badge
App Invites badge badge
Authentication badge badge
Cloud Firestore badge badge
Cloud Functions badge badge
Cloud Messaging badge badge
Cloud Storage badge badge
Crashlytics badge badge
Dynamic Links badge badge
In-app Messaging badge badge
Instance ID badge badge
ML Kit Natural Language badge badge
ML Kit Vision badge badge
Notifications badge badge
Performance Monitoring badge badge
Realtime Database badge badge
Remote Config badge badge
Utils badge badge

Other Packages

React Native Firebase also publishes several other packages, some only used internally, others for public consumption such as Hooks.

Name Description
app-types Common Firebase types used by and all modules.
common Common utilities used by all modules.
hooks (WIP) Official React Hooks for React Native Firebase.

TODO other packages

Documentation

Contributing

License


Built and maintained with 💛 by Invertase.

💼 Hire Us | ☕️ Sponsor Us | ‍💻 Work With Us