mirror of

🔥 A well tested feature rich modular Firebase implementation for React Native. Supports both iOS & Android platforms for over 15 Firebase services. https://invertase.io/oss/react-native-firebase

Go to file

Michael Diarmid 9b6134bb8f Update README.md		2018-09-03 12:52:16 +01:00
.github	Update ISSUE_TEMPLATE.md	2018-02-07 12:48:53 +00:00
android	[android][fabric.crashlytics] update to SDK v2.9.1 (related to / fixes #847 )	2018-03-05 00:34:06 +00:00
bin	[tests] move test scripts into js (bin folder) - now works cross platform	2017-09-25 11:32:18 +01:00
ios	Merge branch 'master' into firestore-transactions	2018-03-05 00:05:37 +00:00
lib	[types] Fix transaction flow type errors	2018-03-08 11:13:21 +00:00
scripts	[install] Get react-native link working with Android	2017-10-05 11:54:37 +01:00
tests	[types] Fix transaction flow type errors	2018-03-08 11:13:21 +00:00
.babelrc	[types] Get types properly exporting as part of the build	2017-11-17 16:17:27 +00:00
.editorconfig	base project files	2017-02-14 16:02:54 +00:00
.eslintrc	[js] Setup prettier	2018-01-25 18:11:37 +00:00
.flowconfig	[flow] Remove custom flow error tag	2018-02-17 12:55:19 +00:00
.gitignore	[internals] update .gitignore	2018-03-04 23:56:02 +00:00
.npmignore	coverage now both platforms	2018-01-09 09:54:16 +00:00
.watchmanconfig	js: snapshot class incorrectly defining 'exists' as a bool prop, instead of a function	2017-03-09 15:27:49 +00:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2018-01-17 18:05:54 +00:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2018-02-19 11:01:24 +00:00
LICENSE	misc cleanup / changes	2018-01-06 13:53:46 +00:00
README.md	Update README.md	2018-09-03 12:52:16 +01:00
React-Native-Firebase.svg	added logo svg	2017-03-24 02:56:28 +00:00
jsconfig.json	Prettier json and md files as well	2018-02-01 12:52:39 +01:00
package-lock.json	3.3.1	2018-03-08 11:36:26 +00:00
package.json	3.3.1	2018-03-08 11:36:26 +00:00
prettier.config.js	Prettier json and md files as well	2018-02-01 12:52:39 +01:00
tsconfig.json	Prettier json and md files as well	2018-02-01 12:52:39 +01:00

README.md

React Native Firebase

Introduction

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.

Although the official Firebase JS SDK will work with React Native; it is mainly built for the web and has a limited feature-set compared to native.

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).

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

Questions

For questions and support please use our Discord chat or Stack Overflow. 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.

Changelog

Detailed changes for each release are documented in the releases notes.

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 and backers. If you'd like to join them, please consider: