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 11052bbb6f Update installation.android.md		2017-04-11 12:50:39 +01:00
android	[android] Remove unused imports	2017-04-10 09:53:17 +01:00
bin	misc build script changes	2017-03-17 14:57:22 +00:00
docs	Update installation.android.md	2017-04-11 12:50:39 +01:00
ios	[js][android][ios][storage] uploadTask.on now correctly receives a success status event	2017-04-07 17:57:57 +01:00
lib	[js][android] Use GoogleApiAvailability to prompt the user to install Google Play Services if it is not installed	2017-04-10 09:50:42 +01:00
.babelrc	base project files	2017-02-14 16:02:54 +00:00
.editorconfig	base project files	2017-02-14 16:02:54 +00:00
.eslintrc	android/js: cleanup / remove redundant code	2017-03-10 18:12:46 +00:00
.flowconfig	add version to .flowconfig	2017-04-04 11:55:50 +01:00
.gitignore	base project files	2017-02-14 16:02:54 +00:00
.npmignore	misc build script changes	2017-03-17 14:57:22 +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
LICENSE	base project files	2017-02-14 16:02:54 +00:00
README.md	Update README.md	2017-04-11 11:25:20 +01:00
RNFirebase.podspec	Fix iOS Podspec issue; Update documentation to make use of pod file for iOS setup rather than react-native link	2017-03-27 12:38:33 +01:00
React-Native-Firebase.svg	added logo svg	2017-03-24 02:56:28 +00:00
index.js	initial commit	2017-04-04 20:47:31 +01:00
package.json	upgrade flow-bin, add npm script for flow	2017-04-04 12:17:04 +01:00

README.md

React Native Firebase

RNFirebase makes using Firebase with React Native simple.

Install

npm i react-native-firebase --save

Platform specific setup guides:

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 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. Firebase will run on the native thread, allowing the rest of your app to run on the JS thread. The Firebase Web SDK also runs on the JS thread, therefore potentially affecting the frame rate causing jank with animations, touch events etc. All in all, RNFirebase provides much faster performance (~2x) over the web SDK.

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, analyics and more!

Test app

To help ensure changes and features work across both iOS & Android, we've developed an app specifically to test react-native-firebase against the firebase web SDK. Please see the react-native-firebase-tests repository for more information.

Examples app

There's currently a work in progress examples app which aims to demonstrate various real world use-case scenarios with React Native & Firebase. We welcome any new examples or updates to existing ones.

Documentation

RNFirebase aims to replicate the Firebase Web SDK as closely as possible. Because of this, the documentation focuses around the installation, differences & best practices of this library. Please see the Firebase Web SDK documentation for Firebase functionality.

If you find any discrepancies between the two libraries, please raise an issue or PR.

Contributing

We welcome any contribution to the repository. Please ensure your changes to the JavaScript code follow the styling guides controlled by ESlint. Changes to native code should be kept clean and follow the standard of existing code.

Changes to existing code should ensure all relevant tests on the test app pass. Any new features should have new tests created and ensure all existing tests pass.

Project board: https://github.com/invertase/react-native-firebase/projects