react-native-firebase/README.md

<p align="center">
  <a href="https://rnfirebase.io">
    <img src="http://i.imgur.com/01XQL0x.png"><br/>
  </a>
  <h2 align="center">React Native Firebase</h2>
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/react-native-firebase"><img src="https://img.shields.io/npm/dm/react-native-firebase.svg?style=flat-square" alt="NPM downloads"></a>
  <a href="https://www.npmjs.com/package/react-native-firebase"><img src="https://img.shields.io/npm/v/react-native-firebase.svg?style=flat-square" alt="NPM version"></a>
  <a href="/LICENSE"><img src="https://img.shields.io/npm/l/react-native-firebase.svg?style=flat-square" alt="License"></a>
  <a href="#backers"><img src="https://opencollective.com/react-native-firebase/backers/badge.svg" alt="Backers on Open Collective"></a>
  <a href="#sponsors"><img src="https://opencollective.com/react-native-firebase/sponsors/badge.svg" alt="Sponsors on Open Collective"></a>
  <a href="https://discord.gg/C9aK28N"><img src="https://img.shields.io/discord/295953187817521152.svg?logo=discord&style=flat-square&colorA=7289da&label=discord" alt="Chat"></a>
  <a href="https://twitter.com/rnfirebase"><img src="https://img.shields.io/twitter/follow/rnfirebase.svg?style=social&label=Follow" alt="Follow on Twitter"></a>
</p>

## Introduction

**RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple. It is a _light-weight_ layer sitting on-top of the native Firebase libraries for both iOS and Android which mirrors the Firebase Web SDK as closely as possible.

Although the [Firebase Web SDK](https://www.npmjs.com/package/firebase) library will work with React Native, it is mainly built for the web.

RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android therefore Firebase will run on the native thread, allowing the rest of your app to run on the [JS thread](https://facebook.github.io/react-native/docs/performance.html#javascript-frame-rate). The Firebase Web SDK also runs on the JS thread, therefore potentially affecting the frame rate causing jank with animations, touch events etc.

The native SDKs also allow us to hook into device sdk's which are not possible with the web SDK, for example crash reporting, offline realtime database support, analytics and more!

All in all, RNFirebase provides much faster performance (~2x) over the web SDK and provides device sdk's not found in the web sdk (see the feature table below).

---

## Supported Firebase Features

> The Web SDK column indicates what modules/functionality from the Web SDK are usable within React Native.

> '**?**' indicates partial support

| Firebase Features          | v1.x.x | v2.x.x | v3.x.x | v3.1.x | v3.2.x | Web SDK |
| -------------------------- | :----: | :----: | :----: | :----: | :----: | :-----: |
| **AdMob**                  |   ❌   |   ✅   |   ✅   |   ✅   |   ✅   |   ❌    |
| **Analytics**              |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ❌    |
| **App Indexing**           |   ❌   |   ❌   |   ❌   |   ❌   |   ❌   |   ❌    |
| **Authentication**         |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ✅    |
| _-- Phone Auth_            |   ❌   |   ❌   |   ✅   |   ✅   |   ✅   |   ❌    |
| **Core**                   |   ❌   | **?**  |   ✅   |   ✅   |   ✅   |   ✅    |
| _-- Multiple Apps_         |   ❌   |   ❌   |   ✅   |   ✅   |   ✅   |   ✅    |
| **Cloud Firestore**        |   ❌   |   ❌   |   ✅   |   ✅   |   ✅   |  **?**  |
| **Cloud Messaging (FCM)**  |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |  **?**  |
| **Crashlytics**            |   ❌   |   ❌   |   ❌   |   ❌   |   ✅   |   ❌    |
| **Crash Reporting**        |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ❌    |
| **Dynamic Links**          |   ❌   |   ❌   |   ❌   |   ✅   |   ✅   |   ❌    |
| **Invites**                |   ❌   |   ❌   |   ❌   | **?**  | **?**  |   ❌    |
| **Performance Monitoring** |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ❌    |
| **Realtime Database**      |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ✅    |
| _-- Offline Persistence_   |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |  **?**  |
| _-- Transactions_          |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ✅    |
| **Remote Config**          |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |   ❌    |
| **Storage**                |   ✅   |   ✅   |   ✅   |   ✅   |   ✅   |  **?**  |

---

### Supported versions - React Native / Firebase

> The table below shows the supported versions of React Native and the Firebase SDKs for different versions of `react-native-firebase`

|                      | 1.X.X       | 2.0.X       | 2.1.X / 2.2.X | 3.0.X    | 3.1.X       | 3.2.X    |
| -------------------- | ----------- | ----------- | ------------- | -------- | ----------- | -------- |
| React Native         | 0.36 - 0.39 | 0.40 - 0.46 | 0.47 +        | 0.48 +   | 0.48 - 0.49 | 0.50 +   |
| Firebase Android SDK | 10.2.0 +    | 11.0.0 +    | 11.0.0 +      | 11.4.2 + | 11.6.0 +    | 11.6.2 + |
| Firebase iOS SDK     | 3.15.0 +    | 4.0.0 +     | 4.0.0 +       | 4.3.0 +  | 4.5.0 +     | 4.7.0 +  |

---

## Documentation

To check out our latest docs, visit [rnfirebase.io](https://rnfirebase.io)

## Questions

For questions and support please use our [Discord chat](https://discord.gg/C9aK28N) or [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase). The issue list of this repo is **exclusively** for bug reports.

## Issues

Please make sure to complete the issue template before opening an issue. Issues not conforming to the guidelines may be closed immediately.

## Feature Requests

For feature requests please use our [Canny Board](http://invertase.link/requests).

## Changelog

Detailed changes for each release are documented in the [releases notes](https://github.com/invertase/react-native-firebase/releases).

<hr>

## Supporting RNFirebase

RNFirebase is an Apache-2.0 licensed open source project. It's an independent project with its ongoing development made possible entirely thanks to the support by these awesome [sponsors](#sponsors) and [backers](#backers). If you'd like to join them, please consider:

* [Become a backer or sponsor on Open Collective](https://opencollective.com/react-native-firebase).

### Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/react-native-firebase#sponsor)]

<a href="https://opencollective.com/react-native-firebase/sponsor/0/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/1/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/2/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/3/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/4/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/5/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/6/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/7/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/8/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/react-native-firebase/sponsor/9/website" target="_blank"><img src="https://opencollective.com/react-native-firebase/sponsor/9/avatar.svg"></a>

### Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/react-native-firebase#backer)]

<a href="https://opencollective.com/react-native-firebase#backers" target="_blank"><img src="https://opencollective.com/react-native-firebase/backers.svg?width=890"></a>

### Contributing

Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request.

Thank you to all the people who have already contributed to RNFirebase!

<a href="graphs/contributors"><img src="https://opencollective.com/react-native-firebase/contributors.svg?width=890" /></a>

<hr>

## License

* See [LICENSE](/LICENSE)