diff --git a/docs/analytics/index.md b/docs/analytics/index.md new file mode 100644 index 00000000..069ef672 --- /dev/null +++ b/docs/analytics/index.md @@ -0,0 +1,72 @@ +--- +title: Analytics +description: Google Analytics for Firebase is a free app measurement solution that provides insight on app usage and user engagement. +--- + +# Analytics + +The analytics module provides out of the box support with Google Analytics for Firebase. +Integration with the Android & iOS allows for in-depth analytical insight reporting, such as +device information, location, user actions and more. + + + +## Install + +To get started, install the module on your platform. Analytics works out of the box once installed! + + + + Follow the Android installation guide. + + + Follow the iOS installation guide. + + + +## Getting Started + + + + Gaining insight into your users behaviour is critical to app success. We've collated a list of our + tips and recommendation for every app you build. + + + Firebase Analytics automatically tracks certain events which cannot be overridden. Understanding + what events are provided out of the box is a great place to start. + + + Take advantage of the simple reference API for analytics and gain more insight into your application and + users. + + + +## Learn more + +Our documentation is a great place to start, however if you're looking for more help or want to help others, +check out the resources below: + +- [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase-analytics) +- [Github Issues](https://github.com/invertase/react-native-firebase/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Aanalytics+) +- [Firebase Documentation](https://firebase.google.com/docs/analytics?utm_source=invertase&utm_medium=react-native-firebase&utm_campaign=analytics) diff --git a/docs/analytics/installation.md b/docs/analytics/installation.md new file mode 100644 index 00000000..078ad625 --- /dev/null +++ b/docs/analytics/installation.md @@ -0,0 +1,9 @@ +--- +title: Analytics Installation +description: Installing Firebase Analytics for Android & iOS +--- + +# Analytics Installation + +TODO + diff --git a/docs/analytics/tips-and-recommendations.md b/docs/analytics/tips-and-recommendations.md new file mode 100644 index 00000000..a7b7617b --- /dev/null +++ b/docs/analytics/tips-and-recommendations.md @@ -0,0 +1,8 @@ +--- +title: Analytics Tips & Recommendations +description: Our tips & recommendations for a better analytical experience +--- + +# Analytics Tips & Recommendations + +## TODO diff --git a/docs/auth/index.md b/docs/auth/index.md index 7de1573b..96c7115f 100644 --- a/docs/auth/index.md +++ b/docs/auth/index.md @@ -17,13 +17,13 @@ To get started, install the module on your platform: Follow the Android installation guide. Follow the iOS installation guide. @@ -36,7 +36,7 @@ To get started, install the module on your platform: icon="build" color="#ffc107" title="Quick Start" - to="/{{ version }}/authentication/quick-start" + to="/{{ version }}/auth/quick-start" > Getting started with authentication? The quick guide will have you up and running in minutes. @@ -52,7 +52,7 @@ To get started, install the module on your platform: icon="layers" color="#03A9F4" title="Reference" - to="/{{ version }}/authentication/reference" + to="/{{ version }}/auth/reference" > The authentication API reference documentation provides detailed information for each of the classes and methods. diff --git a/docs/auth/installation.md b/docs/auth/installation.md index 071fb1f8..08327070 100644 --- a/docs/auth/installation.md +++ b/docs/auth/installation.md @@ -1,9 +1,9 @@ --- -title: Auth Installation -description: Installing Firebase Auth for Android & iOS +title: Authentication Installation +description: Installing Firebase Authentication for Android & iOS --- -# Auth Installation +# Authentication Installation TODO diff --git a/docs/auth/quick-start.md b/docs/auth/quick-start.md new file mode 100644 index 00000000..c4ee6daf --- /dev/null +++ b/docs/auth/quick-start.md @@ -0,0 +1,24 @@ +--- +title: Authentication Quick Start +description: Get to grips with the basics of auth in React Native Firebase +--- + +# Auth Quick Start + +## Module usage + +TODO + +## Subscribe to auth state changes + +TODO + +## Persisting the users auth state + +TODO + +## Reacts lifecycle + +TODO + +## Auth providers diff --git a/docs/firestore/index.md b/docs/firestore/index.md new file mode 100644 index 00000000..76c45c71 --- /dev/null +++ b/docs/firestore/index.md @@ -0,0 +1,71 @@ +--- +title: Cloud Firestore +description: Cloud Firestore is a scalable NoSQL cloud database to store and sync data for client and server-side development. +--- + +# Cloud Firestore + +Cloud Firestore is a NoSQL cloud database to store and sync data between your React Native application +and Firebase's database. The API matches the Firebase Web SDK whilst taking advantage of the native SDKs +performance and offline capabilities. + + + +## Install + +To get started, install the module on your platform: + + + + Follow the Android installation guide. + + + Follow the iOS installation guide. + + + +## Getting Started + + + + Start syncing realtime data in minuties with our quick start guide. + + + Cloud Firestore offers a range of powerful features. Our guides cover both beginner and advanced topics + to get started with. + + + The Cloud Firestore reference API mimics that of the Firebase Web SDK. Our reference documentation covers + every aspect of the module. + + + +## Learn more + +Our documentation is a great place to start, however if you're looking for more help or want to help others, +check out the resources below: + +- [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase-firestore) +- [Github Issues](https://github.com/invertase/react-native-firebase/issues?utf8=%E2%9C%93&q=is%3Aissue+sort%3Aupdated-desc+label%3Afirestore+) +- [Firebase Documentation](https://firebase.google.com/docs/firestore?utm_source=invertase&utm_medium=react-native-firebase&utm_campaign=firestore) diff --git a/docs/firestore/installation.md b/docs/firestore/installation.md new file mode 100644 index 00000000..63731cbe --- /dev/null +++ b/docs/firestore/installation.md @@ -0,0 +1,9 @@ +--- +title: Cloud Firestore Installation +description: Installing Firebase Cloud Firestore for Android & iOS +--- + +# Cloud Firestore Installation + +TODO + diff --git a/docs/firestore/quick-start.md b/docs/firestore/quick-start.md new file mode 100644 index 00000000..5670e266 --- /dev/null +++ b/docs/firestore/quick-start.md @@ -0,0 +1,24 @@ +--- +title: Cloud Firestore Quick Start +description: Get to grips with the basics of Cloud Firestore in React Native Firebase +--- + +# Cloud Firestore Quick Start + +## Module usage + +TODO + +## Subscribe to real time events + +TODO + +## Offline capabilities + +TODO + +## Reacts lifecycle + +TODO + + diff --git a/docs/functions/index.md b/docs/functions/index.md new file mode 100644 index 00000000..c703d505 --- /dev/null +++ b/docs/functions/index.md @@ -0,0 +1,70 @@ +--- +title: Cloud Functions +description: Cloud Functions for Firebase lets you automatically run backend code in response to events triggered by Firebase features and HTTPS requests. +--- + +# Cloud Functions + +Cloud Functions for Firebase lets you automatically run backend code in response to events triggered by Firebase features and HTTPS requests. +React Native Firebase supports integration with production and locally emulated Cloud Functions with a simple API interface. + + + +## Install + +To get started, install the module on your platform: + + + + Follow the Android installation guide. + + + Follow the iOS installation guide. + + + +## Getting Started + + + + Hook your application up with your Cloud Functions in our quick start guide. + + + Combining an application with Cloud Functions allows for rapid development cycles. Our guides + cover how to best utilize Cloud Firestore with other Firebase modules. + + + The API reference covers every aspect to successfully integrate your application with + Cloud Firestore. + + + +## Learn more + +Our documentation is a great place to start, however if you're looking for more help or want to help others, +check out the resources below: + +- [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-firebase-functions) +- [Github Issues](https://github.com/invertase/react-native-firebase/issues?utf8=%E2%9C%93&q=is%3Aissue+sort%3Aupdated-desc+label%3Afunctions+) +- [Firebase Documentation](https://firebase.google.com/docs/functions?utm_source=invertase&utm_medium=react-native-firebase&utm_campaign=functions) diff --git a/docs/functions/installation.md b/docs/functions/installation.md new file mode 100644 index 00000000..24e7bb4d --- /dev/null +++ b/docs/functions/installation.md @@ -0,0 +1,9 @@ +--- +title: Cloud Functions Installation +description: Installing Firebase Cloud Functions for Android & iOS +--- + +# Cloud Functions Installation + +TODO + diff --git a/docs/functions/quick-start.md b/docs/functions/quick-start.md new file mode 100644 index 00000000..43eb8da7 --- /dev/null +++ b/docs/functions/quick-start.md @@ -0,0 +1,15 @@ +--- +title: Cloud Functions Quick Start +description: Get to grips with the basics of Cloud Functions in React Native Firebase +--- + +# Cloud Functions Quick Start + +## Module usage + +TODO + +## Local emulator + +## Cloud Functions Region + diff --git a/docs/sidebar.yaml b/docs/sidebar.yaml index eaa91ecb..e62da0b7 100644 --- a/docs/sidebar.yaml +++ b/docs/sidebar.yaml @@ -1,5 +1,5 @@ -auth: -- group: Authentication +analytics: +- group: Analytics children: - text: Overview to: "/" @@ -7,3 +7,30 @@ auth: to: "/android" - text: iOS Installation to: "/ios" +auth: + - group: Authentication + children: + - text: Overview + to: "/" + - text: Android Installation + to: "/android" + - text: iOS Installation + to: "/ios" +firestore: + - group: Cloud Firestore + children: + - text: Overview + to: "/" + - text: Android Installation + to: "/android" + - text: iOS Installation + to: "/ios" +functions: + - group: Cloud Functions + children: + - text: Overview + to: "/" + - text: Android Installation + to: "/android" + - text: iOS Installation + to: "/ios"