docs: getting started on android FirebaseUI v10#2309
docs: getting started on android FirebaseUI v10#2309russellwheatley wants to merge 4 commits intomasterfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new getting started guide for FirebaseUI Auth v10 on Android. The guide focuses on the new Compose-based authentication library, detailing its integration, configuration, and customization capabilities. It aims to provide developers with a clear path to implement modern authentication flows using Jetpack Compose, while also offering guidance for migrating from previous versions. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
The pull request introduces a new GETTING_STARTED.md documentation file for FirebaseUI Auth for Android, detailing its features, setup, provider configuration, sign-in/out flows, customization, and migration guidance. A review comment suggests improving the dependency declarations in this new guide by replacing <latest-version> placeholders with specific, known-working versions to prevent potential build issues and enhance user experience.
| ## Before you begin | ||
|
|
||
| 1. [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup). | ||
| 2. Make sure your app is set up for Jetpack Compose. |
There was a problem hiding this comment.
What does this mean? Is there a way for us to point developers to docs for them to check whether or not their app is setup for Jetpack Compose?
There was a problem hiding this comment.
Let's assume developers reading this guide are already using Jetpack Compose and remove this line.
| @@ -0,0 +1,270 @@ | |||
| # FirebaseUI Auth for Android | |||
There was a problem hiding this comment.
Keeping the existing title
| # FirebaseUI Auth for Android | |
| # Easily add sign-in to your Android app with FirebaseUI |
| @@ -0,0 +1,270 @@ | |||
| # FirebaseUI Auth for Android | |||
|
|
|||
| FirebaseUI Auth is a modern, Compose-based authentication library for Firebase Authentication on Android. | |||
There was a problem hiding this comment.
Let's keep the existing text?
| FirebaseUI Auth is a modern, Compose-based authentication library for Firebase Authentication on Android. | |
| [FirebaseUI](https://github.com/firebase/firebaseui-android) Auth is a library built on top of the Firebase Authentication SDK that provides drop-in UI flows for use in your app. |
|
|
||
| FirebaseUI Auth is a modern, Compose-based authentication library for Firebase Authentication on Android. | ||
|
|
||
| `10.x` is currently a beta release. |
There was a problem hiding this comment.
| `10.x` is currently a beta release. | |
| Caution: Version 10.x is currently a **beta release**. This means that the functionality might change in backward-incompatible ways or have limited support. A beta release is not subject to any SLA or deprecation policy. |
Using "Caution:" will render this paragraph as a warning similar to this:
|
|
||
| `10.x` is currently a beta release. | ||
|
|
||
| If you used the older FirebaseUI Auth guides, the biggest change in `10.x` is that the recommended sign-in flow now uses Compose screens instead of `Intent` builders and `ActivityResultLauncher` callbacks. For apps that still use Activities, see [Existing Activity-based apps](#existing-activity-based-apps). |
There was a problem hiding this comment.
| If you used the older FirebaseUI Auth guides, the biggest change in `10.x` is that the recommended sign-in flow now uses Compose screens instead of `Intent` builders and `ActivityResultLauncher` callbacks. For apps that still use Activities, see [Existing Activity-based apps](#existing-activity-based-apps). | |
| If you used the older FirebaseUI Auth guides, the biggest change in `10.x` is that the recommended sign-in flow now uses Compose screens instead of `Intent` builders and `ActivityResultLauncher` callbacks. For apps that still use Activities, see the [Existing Activity-based apps](#existing-activity-based-apps) section. |
|
|
||
| ## Before you begin | ||
|
|
||
| 1. [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup). |
There was a problem hiding this comment.
| 1. [Add Firebase to your Android project](https://firebase.google.com/docs/android/setup). | |
| 1. If you haven't already, [add Firebase to your Android project](https://firebase.google.com/docs/android/setup). |
| // Required: Jetpack Compose | ||
| // Find the latest Compose BOM version here: | ||
| // https://developer.android.com/develop/ui/compose/bom | ||
| implementation(platform("androidx.compose:compose-bom:2026.03.00")) | ||
| implementation("androidx.compose.material3:material3") |
| } | ||
| ``` | ||
|
|
||
| The high-level FirebaseUI Auth API is Compose-based, so if your app is not already using Compose you will need to enable it first. |
|
|
||
| ### Google Sign-In | ||
|
|
||
| - Enable Google in the Firebase console. |
There was a problem hiding this comment.
| - Enable Google in the Firebase console. | |
| - Enable Google Sign-in in the Firebase console. |
| Some providers need additional setup before you can sign users in. | ||
|
|
There was a problem hiding this comment.
What if we had a list pointing to the other docs instead of detailing the steps for each of the providers?
For example:
| Some providers need additional setup before you can sign users in. | |
| Some providers need additional setup before you can sign users in: | |
| - [Sign in with Google](https://firebase.google.com/docs/auth/android/google-signin) | |
| - [Facebook Login](https://firebase.google.com/docs/auth/android/facebook-login) |
(this example is not exhaustive)
|
|
||
| This gives you a complete authentication flow with: | ||
|
|
||
| - Email/password sign-in and sign-up. |
There was a problem hiding this comment.
| - Email/password sign-in and sign-up. | |
| - Password Authentication. |
Uh oh!
There was an error while loading. Please reload this page.