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

Elliot Hesp 7b7d6a07da Update README.md		2017-03-17 14:58:28 +00:00
android	[android, ios] currentUser.getToken() - now uses promise and correctly returns a string	2017-03-16 12:35:03 +00:00
bin	Rename pod	2017-03-10 14:18:07 +00:00
docs	Update Android installation instructions	2017-03-17 14:39:50 +00:00
ios	[android, ios] currentUser.getToken() - now uses promise and correctly returns a string	2017-03-16 12:35:03 +00:00
lib	[js] prefix snapshot internals with '_'	2017-03-16 16:48:03 +00: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	base project files	2017-02-14 16:02:54 +00:00
.gitignore	base project files	2017-02-14 16:02:54 +00:00
.npmignore	#v1.0.0-alpha3	2017-03-17 13:27:04 +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-03-17 14:58:28 +00:00
RNFirebase.podspec	[js] prefix snapshot internals with '_'	2017-03-16 16:48:03 +00:00
firebase.android.js	android: fixed once and on error handling	2017-03-07 16:54:04 +00:00
firebase.ios.js	base project files	2017-02-14 16:02:54 +00:00
index.js	android: fixed once and on error handling	2017-03-07 16:54:04 +00:00
package.json	#v1.0.0-alpha3	2017-03-17 13:27:04 +00:00

README.md

React Native Firebase

RNFirebase makes using the latest Firebase with React Native straight-forward.

npm i react-native-firebase --save

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.

RNFirebase vs Firebase Web SDK

Although the Firebase Web SDK library will work with React Native, it is built for the web.

RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android. The Firebase processes 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 frane rate causing jank with animations, touch events etc. All in, RNFirebase provides much faster performance (~2x) over the web SDK.

The native SDKs allow allow us to hook into device events which are not possible with the web SDK, for example crash reporting, offiline 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.