mirror of
https://github.com/zhigang1992/react-native-firebase.git
synced 2026-05-08 12:00:32 +08:00
GitBook: [master] 3 pages modified
This commit is contained in:
Michael Diarmid
committed by
gitbook-bot
gitbook-bot
parent
28615dd810
commit
a5cd409e42
103
README.md
103
README.md
@@ -1,103 +1,4 @@
|
||||
<p align="center">
|
||||
<a href="https://invertase.io/oss/react-native-firebase">
|
||||
<img width="160px" src="https://i.imgur.com/JIyBtKW.png"><br/>
|
||||
</a>
|
||||
<h2 align="center">React Native Firebase</h2>
|
||||
</p>
|
||||
# Introduction
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/@react-native-firebase/app"><img src="https://img.shields.io/npm/dm/@react-native-firebase/app.svg?style=flat-square" alt="NPM downloads"></a>
|
||||
<a href="https://www.npmjs.com/package/@react-native-firebase/app"><img src="https://img.shields.io/npm/v/@react-native-firebase/app.svg?style=flat-square" alt="NPM version"></a>
|
||||
<a href="/LICENSE"><img src="https://img.shields.io/npm/l/@react-native-firebase/app.svg?style=flat-square" alt="License"></a>
|
||||
<a href="https://lerna.js.org/"><img src="https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg?style=flat-square" alt="Maintained with Lerna"></a>
|
||||
</p>
|
||||
This file file serves as your book's preface, a great place to describe your book's content and ideas.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://invertase.link/discord"><img src="https://img.shields.io/discord/295953187817521152.svg?style=flat-square&colorA=7289da&label=Chat%20on%20Discord" alt="Chat on Discord"></a>
|
||||
<a href="https://twitter.com/rnfirebase"><img src="https://img.shields.io/twitter/follow/rnfirebase.svg?style=flat-square&colorA=1da1f2&colorB=&label=Follow%20on%20Twitter" alt="Follow on Twitter"></a>
|
||||
<a href="https://www.facebook.com/groups/rnfirebase"><img src="https://img.shields.io/badge/Follow%20on%20Facebook-4172B8?logo=facebook&style=flat-square&logoColor=fff" alt="Follow on Facebook"></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
> Looking for the legacy version of React Native Firebase? See the [v5.x.x branch](https://github.com/invertase/react-native-firebase/tree/v5.x.x).
|
||||
|
||||
---
|
||||
|
||||
**React Native Firebase** is a collection of official React Native modules connecting you to Firebase services; each module is a light-weight javascript layer connecting you to the native Firebase SDKs for both iOS and Android.
|
||||
|
||||
React Native Firebase is built with four key principals in mind;
|
||||
|
||||
- 🧪 **Well tested**
|
||||
- every module is extensively tested to >95% coverage
|
||||
- 👁 **Well typed**
|
||||
- first class support for Typescript included
|
||||
- 📄 **Well documented**
|
||||
- full reference & installation documentation alongside detailed guides and FAQs
|
||||
- 🔥 **Mirrors official Firebase Web SDK**
|
||||
- functions as a drop-in replacement for the Firebase Web SDK in React Native
|
||||
- maximises cross-platform code re-usability e.g. re-using code on web platforms
|
||||
|
||||
## Firebase Modules
|
||||
|
||||
This is the root of the monorepo for React Native Firebase, if you're looking for a specific package please select the package link from below.
|
||||
|
||||
The main package that you interface with is `App` (`@react-native-firebase/app`)
|
||||
|
||||
| Name | Downloads | Coverage |
|
||||
| -------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| [AdMob](/packages/admob) | [](https://www.npmjs.com/package/@react-native-firebase/admob) | [](https://api.rnfirebase.io/coverage/admob/detail) |
|
||||
| [Analytics](/packages/analytics) | [](https://www.npmjs.com/package/@react-native-firebase/analytics) | [](https://api.rnfirebase.io/coverage/analytics/detail) |
|
||||
| [App](/packages/app) | [](https://www.npmjs.com/package/@react-native-firebase/app) | [](https://api.rnfirebase.io/coverage/app/detail) |
|
||||
| [Authentication](/packages/auth) | [](https://www.npmjs.com/package/@react-native-firebase/auth) | [](https://api.rnfirebase.io/coverage/auth/detail) |
|
||||
| [Cloud Firestore](/packages/firestore) | [](https://www.npmjs.com/package/@react-native-firebase/firestore) | [](https://api.rnfirebase.io/coverage/firestore/detail) |
|
||||
| [Cloud Functions](/packages/functions) | [](https://www.npmjs.com/package/@react-native-firebase/functions) | [](https://api.rnfirebase.io/coverage/functions/detail) |
|
||||
| [Cloud Messaging](/packages/messaging) | [](https://www.npmjs.com/package/@react-native-firebase/messaging) | [](https://api.rnfirebase.io/coverage/messaging/detail) |
|
||||
| [Cloud Storage](/packages/storage) | [](https://www.npmjs.com/package/@react-native-firebase/storage) | [](https://api.rnfirebase.io/coverage/storage/detail) |
|
||||
| [Crashlytics](/packages/crashlytics) | [](https://www.npmjs.com/package/@react-native-firebase/crashlytics) | [](https://api.rnfirebase.io/coverage/crashlytics/detail) |
|
||||
| [Dynamic Links](/packages/dynamic-links) | [](https://www.npmjs.com/package/@react-native-firebase/dynamic-links) | [](https://api.rnfirebase.io/coverage/dynamic-links/detail) |
|
||||
| [In-app Messaging](/packages/in-app-messaging) | [](https://www.npmjs.com/package/@react-native-firebase/in-app-messaging) | [](https://api.rnfirebase.io/coverage/in-app-messaging/detail) |
|
||||
| [Instance ID](/packages/iid) | [](https://www.npmjs.com/package/@react-native-firebase/iid) | [](https://api.rnfirebase.io/coverage/iid/detail) |
|
||||
| [ML Kit Natural Language](/packages/ml-natural-language) | [](https://www.npmjs.com/package/@react-native-firebase/ml-natural-language) | [](https://api.rnfirebase.io/coverage/ml-natural-language/detail) |
|
||||
| [ML Kit Vision](/packages/ml-vision) | [](https://www.npmjs.com/package/@react-native-firebase/ml-vision) | [](https://api.rnfirebase.io/coverage/ml-vision/detail) |
|
||||
| [Performance Monitoring](/packages/perf) | [](https://www.npmjs.com/package/@react-native-firebase/perf) | [](https://api.rnfirebase.io/coverage/perf/detail) |
|
||||
| [Realtime Database](/packages/database) | [](https://www.npmjs.com/package/@react-native-firebase/database) | [](https://api.rnfirebase.io/coverage/database/detail) |
|
||||
| [Remote Config](/packages/remote-config) | [](https://www.npmjs.com/package/@react-native-firebase/remote-config) | [](https://api.rnfirebase.io/coverage/remote-config/detail) |
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Overview](https://invertase.io/oss/react-native-firebase)
|
||||
- [Quick Start](https://invertase.io/oss/react-native-firebase/quick-start)
|
||||
- [Guides](https://invertase.io/oss/react-native-firebase/guides)
|
||||
- [Modules](https://invertase.io/oss/react-native-firebase/v6)
|
||||
|
||||
## Contributing
|
||||
|
||||
- [Overview](https://invertase.io/oss/react-native-firebase/contributing)
|
||||
- [Issues & PRs](https://invertase.io/oss/react-native-firebase/contributing/issues-prs-pm)
|
||||
- [Documentation](https://invertase.io/oss/react-native-firebase/contributing/documentation)
|
||||
- [Code & Testing](https://invertase.io/oss/react-native-firebase/contributing/code-testing-review)
|
||||
- [Marketing & Content](https://invertase.io/oss/react-native-firebase/contributing/marketing-content)
|
||||
- [Community](https://invertase.io/oss/react-native-firebase/contributing/community)
|
||||
- [Donating](https://invertase.io/oss/react-native-firebase/contributing/donations-expenses)
|
||||
- [Code of Conduct](/CODE_OF_CONDUCT.md)
|
||||
|
||||
## License
|
||||
|
||||
- See [LICENSE](/LICENSE)
|
||||
|
||||
---
|
||||
|
||||
<p>
|
||||
<img align="left" width="75px" src="https://static.invertase.io/assets/invertase-logo-small.png">
|
||||
<p align="left">
|
||||
Built and maintained with 💛 by <a href="https://invertase.io">Invertase</a>.
|
||||
</p>
|
||||
<p align="left">
|
||||
<a href="https://invertase.io/hire-us">💼 Hire Us</a> |
|
||||
<a href="https://opencollective.com/react-native-firebase">☕️ Sponsor Us</a> |
|
||||
<a href="https://opencollective.com/jobs">💻 Work With Us</a>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
8
SUMMARY.md
Normal file
8
SUMMARY.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Table of contents
|
||||
|
||||
* [Introduction](README.md)
|
||||
|
||||
## Methods
|
||||
|
||||
* [Defining Methods](methods/methods.md)
|
||||
|
||||
32
methods/methods.md
Normal file
32
methods/methods.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Defining Methods
|
||||
|
||||
Methods allow you to smoothly display code examples in different languages.
|
||||
|
||||
## My first method
|
||||
|
||||
My first method exposes how to print a message in JavaScript and Go.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="JavaScript" %}
|
||||
Here is how to print a message to `stdout` using JavaScript.
|
||||
|
||||
```javascript
|
||||
console.log('My first method');
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Go" %}
|
||||
Here is how to print a message to `stdout` using Go.
|
||||
|
||||
```go
|
||||
fmt.Println("My first method")
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
Whatever language you are using, the result will be the same.
|
||||
|
||||
```bash
|
||||
$ My first method
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user