Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 5.22 KB

getting-started.md

File metadata and controls

92 lines (63 loc) · 5.22 KB

Introduction

React Native Firebase makes using Firebase with React Native simple. It provides a light-weight layer on-top of the native Firebase SDKs (iOS & Android) whilst mirroring the Firebase Web SDKs API as closely as possible.

Why

Although some features from the Firebase Web SDK will generally work with React Native, it is mainly built for the web and as such has a limited compatible feature set.

In contrast we use the Firebase Native SDKs - this allows us to provide APIs to a vast majority of Firebase products and services.

See the Supported Firebase Features table below to compare our supported features.

Getting Started

We provide several options for you to get started with React Native Firebase, select a method from the table below that matches your requirements:

Manual Integration Free Starter Kit
[manual](version /installation/initial-setup) [basic](version /installation/basic-kit)
Manually integrate React Native Firebase into your project by following our Android and iOS setup guides. We've installed React Native Firebase into the standard React Native template app with only minimal steps for you to get going.
Recommended for experienced React Native developers and existing React Native projects. Recommended for beginners and new React Native projects.
[continue](version /installation/initial-setup) [btn-kit](version /installation/basic-kit)

Supported Firebase Features

The Web SDK column indicates what modules/functionality from the Web SDK are usable within React Native. A '?' indicates partial support.

Firebase Features v5.x.x Web SDK
AdMob
Analytics            
App Indexing          
Authentication
-- Phone Auth
Core
-- Multiple Apps
Cloud Firestore
Cloud Messaging (FCM)
Crashlytics          
Dynamic Links
Functions Callable               ✅   ✅  
Invites
Instance ID         
Performance Monitoring
Realtime Database
-- Offline Persistence ?
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

3.3.x 4.3.x 5.x.x
React Native 0.50-52 0.52-55 ^0.56 - ^0.58
Play Services Android SDK 11.8.0 + 15.0.1 ^16.0.1
Firebase iOS SDK 4.7.0 + 5.3.0 ^5.10.0 - ^5.15.0

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 visit our Feature Request Board.

Changelog

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

Contributing

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who have already contributed to React Native Firebase!