2017-11-06 13:42:50 +00:00
< p align = "center" >
< a href = "https://rnfirebase.io" >
2018-03-20 17:58:40 +00:00
< img src = "https://i.imgur.com/eBNJlHd.png" > < br / >
2017-11-06 13:42:50 +00:00
< / a >
2017-11-06 13:45:08 +00:00
< h2 align = "center" > React Native Firebase< / h2 >
2017-11-06 13:42:50 +00:00
< / 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 >
2018-02-13 14:23:09 +00:00
< 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 >
2017-11-06 13:42:50 +00:00
< 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
2018-08-05 02:21:52 +00:00
**React Native Firebase** is a _light-weight_ javascript layer connecting you to the native Firebase SDKs for both iOS and Android which aimes to mirror the offical Firebase Web SDK as closely as possible.
2017-03-23 17:05:28 +00:00
2018-08-05 02:22:48 +00:00
Although the official [Firebase JS SDK ](https://www.npmjs.com/package/firebase ) will work with React Native; it is mainly built for the web and has a limited feature-set compared to native.
2017-03-23 17:12:52 +00:00
2018-08-05 02:22:48 +00:00
Using the native Firebase SDKs with **React Native Firebase** allows you to consume device SDKs which don't exist on the Firebase JS SDK - for example; Remote Config, Performance Monitoring, Dynamic Links, Analytics and more (see the feature table below for comparison).
2017-06-20 19:58:57 +00:00
2017-06-14 22:51:01 +00:00
---
2017-11-06 13:42:50 +00:00
2017-08-28 14:12:06 +00:00
## Supported Firebase Features
2018-02-01 11:52:39 +00:00
> The Web SDK column indicates what modules/functionality from the Web SDK are usable within React Native.
2017-08-28 14:12:06 +00:00
> '**?**' indicates partial support
2018-08-05 01:23:09 +00:00
| Firebase Features | v2.2.x | v3.3.x | v4.3.x | Web SDK |
2018-05-18 07:01:40 +00:00
| --------------------------------------------------------------------------------------------------------------------------------- | :----: | :----: | :----: | :-----: |
| **AdMob** | ✅ | ✅ | ✅ | ❌ |
| **Analytics**
| **App Indexing**
| **Authentication** | ✅ | ✅ | ✅ | ✅ |
| _-- Phone Auth_ | ❌ | ✅ | ✅ | ❌ |
| **Core** | ** ?** | ✅ | ✅ | ✅ |
| _-- Multiple Apps_ | ❌ | ✅ | ✅ | ✅ |
| **Cloud Firestore** | ❌ | ✅ | ✅ | ** ?** |
| **Cloud Messaging (FCM)** | ** ?** | ** ?** | ✅ | ❌ |
| **Crashlytics**
| **Dynamic Links** | ❌ | ✅ | ✅ | ❌ |
2018-07-13 07:29:10 +00:00
| ** [Functions Callable ](https://firebase.googleblog.com/2018/04/launching-cloud-functions-for-firebase-1-0.html?m=1 )**
2018-05-18 07:01:40 +00:00
| **Invites** | ❌ | ❌ | ✅ | ❌ |
| **Instance ID** ** ?** | ❌ |
| **Performance Monitoring** | ✅ | ✅ | ✅ | ❌ |
| **Realtime Database** | ✅ | ✅ | ✅ | ✅ |
| _-- Offline Persistence_ | ✅ | ✅ | ✅ | ** ?** |
| **Remote Config** | ✅ | ✅ | ✅ | ❌ |
| **Storage** | ✅ | ✅ | ✅ | ** ?** |
2017-06-16 16:51:46 +00:00
---
2018-02-01 11:52:39 +00:00
2017-08-03 07:57:19 +00:00
### Supported versions - React Native / Firebase
2017-06-16 16:51:46 +00:00
2018-05-17 08:56:31 +00:00
> The table below shows the supported versions of React Native and the Firebase SDKs for different versions of `react-native-firebase`.
2017-06-16 16:51:46 +00:00
2018-08-05 01:23:09 +00:00
| | 3.3.x | 4.3.x | 5.0.x |
| ------------------------- | :------: | :-----: | :---: |
| React Native | 0.50 + | 0.52-55 | 0.56+ |
| Play Services Android SDK | 11.8.0 + | 15.0.1 | TBC |
| Firebase iOS SDK | 4.7.0 + | 5.3.0 | TBC |
2017-06-14 22:51:01 +00:00
---
2017-02-14 16:02:54 +00:00
2017-11-06 13:42:50 +00:00
## Documentation
2017-11-03 19:39:11 +00:00
2018-08-02 16:09:36 +00:00
To check out our latest docs, visit [https://invertase.io/oss/react-native-firebase ](https://invertase.io/oss/react-native-firebase )
2017-11-06 13:42:50 +00:00
## Questions
2018-02-07 12:50:19 +00:00
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.
2017-11-06 13:42:50 +00:00
## Issues
2017-11-03 19:39:11 +00:00
2017-11-06 13:42:50 +00:00
Please make sure to complete the issue template before opening an issue. Issues not conforming to the guidelines may be closed immediately.
## Feature Requests
2018-08-01 11:47:35 +00:00
For feature requests please visit our [Feature Request Board ](https://boards.invertase.io/react-native-firebase ).
2017-11-06 13:42:50 +00:00
## Changelog
Detailed changes for each release are documented in the [releases notes ](https://github.com/invertase/react-native-firebase/releases ).
2018-08-05 02:21:52 +00:00
----
2017-11-06 13:42:50 +00:00
2017-11-06 15:07:37 +00:00
## Supporting RNFirebase
2017-11-06 13:42:50 +00:00
2017-11-06 15:07:37 +00:00
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:
2017-11-03 19:39:11 +00:00
2018-08-05 01:23:09 +00:00
- [Become a backer or sponsor on Open Collective ](https://opencollective.com/react-native-firebase ).
2017-11-03 19:39:11 +00:00
2017-11-06 15:07:37 +00:00
### Sponsors
2017-11-03 19:39:11 +00:00
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 >
2017-11-06 15:07:37 +00:00
### 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 >
2017-11-06 13:42:50 +00:00
## License
2017-03-16 16:27:01 +00:00
2018-08-05 01:23:09 +00:00
- See [LICENSE ](/LICENSE )
