react-native-firebase/README.md

# React Native Firebase<a href="https://invertase.io/react-native-firebase"><img align="left" src="http://i.imgur.com/01XQL0x.png"></a>

[![npm version](https://img.shields.io/npm/v/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase)
[![NPM downloads](https://img.shields.io/npm/dm/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase)
[![Package Quality](http://npm.packagequality.com/shield/react-native-firebase.svg?style=flat-square)](http://packagequality.com/#?package=react-native-firebase)
[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square)](https://discord.gg/t6bdqMs)
[![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg?style=flat-square)](https://www.patreon.com/invertase)
[![Twitter Follow](https://img.shields.io/twitter/follow/rnfirebase.svg?style=social&label=Follow)](https://twitter.com/rnfirebase)


**RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple. 

---

We also support **both** databases: Realtime Database and Cloud Firestore!

---


<!---
[![License](https://img.shields.io/npm/l/react-native-firebase.svg?style=flat-square)](/LICENSE)
-->

<hr>

> [Docs](http://invertase.link/v3-docs) <b>|</b> [iOS Install Guide](http://invertase.link/ios) <b>|</b> [Android Install Guide](http://invertase.link/android) <b>|</b> [FAQs](http://invertase.io/react-native-firebase/#/faqs) <b>|</b> [Feature Requests](http://invertase.link/requests)

<hr>

### Install
```bash
npm i react-native-firebase --save
```

<hr>

### Why

RNFirebase 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 | Web SDK |
| ---------------------- | :---: | :---: | :---: | :---: |
| **AdMob**                  | ❌ | ✅ | ✅ | ❌ |
| **Analytics**              | ✅ | ✅ | ✅ | ❌ |
| **App Indexing**           | ❌ | ❌ | ❌ | ❌ |
| **Authentication**         | ✅ | ✅ | ✅ | ✅ |
| _-- Phone Auth_            | ❌ | ❌ | ✅ | ❌ |
| **Core**                   | ❌ |**?**| ✅ | ✅ |
|  _-- Multiple Apps_        | ❌ | ❌ | ✅ | ✅ |
| **Cloud Messaging (FCM)**  | ✅ | ✅ | ✅ |**?**|
| **Crash Reporting**        | ✅ | ✅ | ✅ | ❌ |
| **Dynamic Links**          | ❌ | ❌ | ❌ | ❌ |
| **Firestore**              | ❌ | ❌ | ✅ | ❌ |
| **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    |
|------------------------|-------------|-------------|-----------------|----------|
| React Native           | 0.36 - 0.39 | 0.40 - 0.46 | 0.47 +          | 0.48 +   |
| Firebase Android SDK   | 10.2.0 +    | 11.0.0 +    | 11.0.0 +        | 11.4.2 + |
| Firebase iOS SDK       | 3.15.0 +    | 4.0.0 +     | 4.0.0 +         | 4.3.0 +  |

---

### License

- See [LICENSE](/LICENSE)
-												Update README.md

											
										
										
											2017-04-27 11:39:37 +00:00
+								# React Native Firebase<a href="https://invertase.io/react-native-firebase"><img align="left" src="http://i.imgur.com/01XQL0x.png"></a>
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
-												Update README.md
											
										
										
											2017-06-20 19:44:21 +00:00
+								[![npm version](https://img.shields.io/npm/v/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase)
 								[![NPM downloads](https://img.shields.io/npm/dm/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase)
-												Update README.md
											
										
										
											2017-06-20 19:46:16 +00:00
+								[![Package Quality](http://npm.packagequality.com/shield/react-native-firebase.svg?style=flat-square)](http://packagequality.com/#?package=react-native-firebase)
-												Update README.md
											
										
										
											2017-06-20 19:44:21 +00:00
+								[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square)](https://discord.gg/t6bdqMs)
 								[![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg?style=flat-square)](https://www.patreon.com/invertase)
-												[docs] Update Twitter link

											
										
										
											2017-10-03 15:24:10 +00:00
+								[![Twitter Follow](https://img.shields.io/twitter/follow/rnfirebase.svg?style=social&label=Follow)](https://twitter.com/rnfirebase)
-												Update README.md
											
										
										
											2017-06-20 19:44:21 +00:00
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
-												Update README.md
											
										
										
											2017-10-03 17:16:14 +00:00
+								**RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple.
-												Update README.md
											
										
										
											2017-10-03 17:17:07 +00:00
+								---
 								We also support **both** databases: Realtime Database and Cloud Firestore!
 								---
-												Update README.md
											
										
										
											2017-03-23 17:05:28 +00:00
-												remove license badge

add back in once v3 live - shows published npm versions license which for v3 is currently wrong.
											
										
										
											2017-09-25 17:47:34 +00:00
+								<!---
 								[![License](https://img.shields.io/npm/l/react-native-firebase.svg?style=flat-square)](/LICENSE)
 								-->
-												Update README.md
											
										
										
											2017-06-20 19:49:49 +00:00
+								<hr>
-												v3 / firestore changes

											
										
										
											2017-10-03 17:04:00 +00:00
+								> [Docs](http://invertase.link/v3-docs) <b>|</b> [iOS Install Guide](http://invertase.link/ios) <b>|</b> [Android Install Guide](http://invertase.link/android) <b>|</b> [FAQs](http://invertase.io/react-native-firebase/#/faqs) <b>|</b> [Feature Requests](http://invertase.link/requests)
-												Cleanup main README

											
										
										
											2017-04-27 11:25:29 +00:00
-												Update README.md

											
										
										
											2017-04-27 11:39:37 +00:00
+								<hr>
-												Update README.md
											
										
										
											2017-03-23 17:05:28 +00:00
+								### Install
-												Cleanup main README

											
										
										
											2017-04-27 11:25:29 +00:00
+								```bash
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
+								npm i react-native-firebase --save
 								```
-												Update README.md
											
										
										
											2017-03-23 17:12:52 +00:00
+								<hr>
 								### Why
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
-												Update README.md
											
										
										
											2017-03-23 17:05:28 +00:00
+								RNFirebase 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.
-												Update README.md
											
										
										
											2017-03-23 17:12:52 +00:00
+								Although the [Firebase Web SDK](https://www.npmjs.com/package/firebase) library will work with React Native, it is mainly built for the web.
-												[docs] Update main readme with supported versions

											
										
										
											2017-08-03 07:57:19 +00:00
+								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.
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
-												Fix typo in readme.md

add a 't' to analy't'ics
											
										
										
											2017-08-07 21:32:03 +00:00
+								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!
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
-												Update README.md
											
										
										
											2017-06-20 19:58:57 +00:00
+								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).
-												added supported features table
											
										
										
											2017-06-14 22:51:01 +00:00
+								---
-												update features table
											
										
										
											2017-08-28 14:12:06 +00:00
+								## 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 | Web SDK |
 								| ---------------------- | :---: | :---: | :---: | :---: |
 								| **AdMob**                  | ❌ | ✅ | ✅ | ❌ |
 								| **Analytics**              | ✅ | ✅ | ✅ | ❌ |
 								| **App Indexing**           | ❌ | ❌ | ❌ | ❌ |
 								| **Authentication**         | ✅ | ✅ | ✅ | ✅ |
 								| _-- Phone Auth_            | ❌ | ❌ | ✅ | ❌ |
 								| **Core**                   | ❌ |**?**| ✅ | ✅ |
 								|  _-- Multiple Apps_        | ❌ | ❌ | ✅ | ✅ |
 								| **Cloud Messaging (FCM)**  | ✅ | ✅ | ✅ |**?**|
 								| **Crash Reporting**        | ✅ | ✅ | ✅ | ❌ |
 								| **Dynamic Links**          | ❌ | ❌ | ❌ | ❌ |
-												[docs] Add some basic Firestore docs for launch

											
										
										
											2017-10-03 11:03:16 +00:00
+								| **Firestore**              | ❌ | ❌ | ✅ | ❌ |
-												update features table
											
										
										
											2017-08-28 14:12:06 +00:00
+								| **Invites**                | ❌ | ❌ | ❌ | ❌ |
 								| **Performance Monitoring** | ✅ | ✅ | ✅ | ❌ |
 								| **Realtime Database**      | ✅ | ✅ | ✅ | ✅ |
 								| _-- Offline Persistence_   | ✅ | ✅ | ✅ |**?**|
 								| _-- Transactions_          | ✅ | ✅ | ✅ | ✅ |
 								| **Remote Config**          | ✅ | ✅ | ✅ | ❌ |
 								| **Storage**                | ✅ | ✅ | ✅ |**?**|
-												[docs] Alphabetise features, add supported versions

											
										
										
											2017-06-16 16:51:46 +00:00
 								---
-												[docs] Update main readme with supported versions

											
										
										
											2017-08-03 07:57:19 +00:00
+								### Supported versions - React Native / Firebase
-												[docs] Alphabetise features, add supported versions

											
										
										
											2017-06-16 16:51:46 +00:00
-												[docs] Update how version table is structured

											
										
										
											2017-10-03 15:21:18 +00:00
+								> The table below shows the supported versions of React Native and the Firebase SDKs for different versions of `react-native-firebase`
-												[docs] Alphabetise features, add supported versions

											
										
										
											2017-06-16 16:51:46 +00:00
-												[docs] Update Twitter link

											
										
										
											2017-10-03 15:24:10 +00:00
+								|                        | 1.X.X       | 2.0.X       | 2.1.X / 2.2.X   | 3.0.X    |
 								|------------------------|-------------|-------------|-----------------|----------|
 								| React Native           | 0.36 - 0.39 | 0.40 - 0.46 | 0.47 +          | 0.48 +   |
-												Bump to final versions of Firestore iOS and Android libraries

											
										
										
											2017-10-03 16:23:28 +00:00
+								| Firebase Android SDK   | 10.2.0 +    | 11.0.0 +    | 11.0.0 +        | 11.4.2 + |
 								| Firebase iOS SDK       | 3.15.0 +    | 4.0.0 +     | 4.0.0 +         | 4.3.0 +  |
-												added supported features table
											
										
										
											2017-06-14 22:51:01 +00:00
 								---
-												base project files

											
										
										
											2017-02-14 16:02:54 +00:00
-												Update README.md
											
										
										
											2017-03-23 17:09:49 +00:00
+								### License
-												Update README descriptions
											
										
										
											2017-03-16 16:27:01 +00:00
-												Update README.md
											
										
										
											2017-09-08 16:49:34 +00:00
+								- See [LICENSE](/LICENSE)