Skip to content

Add OAuth and Sign In with Apple to README #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 20, 2019
Merged

Add OAuth and Sign In with Apple to README #816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3914e0a
Add OAuth and Sign In with Apple to README
morganchen12 Dec 20, 2019
70f6806
Auth README nits
morganchen12 Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions Auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ FirebaseUI can be easily customized to fit in with the rest of your app's visual
style, and it is open source, so you aren't constrained in realizing the user
experience you want.

Compatible FirebaseUI clients are also available for [Android](https://github.com/firebase/firebaseui-android/tree/master/auth)
Compatible FirebaseUI Auth clients are also available for
[Android](https://github.com/firebase/firebaseui-android/tree/master/auth)
and [Web](https://github.com/firebase/firebaseui-web/).

## Table of Contents
Expand Down Expand Up @@ -49,6 +50,8 @@ Auth guides at the following links:
- [Google](https://firebase.google.com/docs/auth/ios/google-signin#before_you_begin)
- [Facebook](https://firebase.google.com/docs/auth/ios/facebook-login#before_you_begin)
- [Phone](https://firebase.google.com/docs/auth/ios/phone-auth#before_you_begin)
- [Sign in with Apple](https://firebase.google.com/docs/auth/ios/apple#before_you_begin)
- For Sign in with Apple, read the [Comply with Apple anonymized data requirements](https://firebase.google.com/docs/auth/ios/apple#comply-with-apple-anonymized-data-requirements) section as well.

## Using FirebaseUI for Authentication

Expand Down Expand Up @@ -95,8 +98,13 @@ let providers: [FUIAuthProvider] = [
FUIGoogleAuth(),
FUIFacebookAuth(),
FUIPhoneAuth(authUI: FUIAuth.defaultAuthUI()),
FUIOAuth.appleAuthProvider(),
FUIOAuth.twitterAuthProvider(),
FUIOAuth.githubAuthProvider(),
FUIOAuth.microsoftAuthProvider(),
FUIOAuth.yahooAuthProvider(),
]
self.authUI?.providers = providers
authUI?.providers = providers
```

```objective-c
Expand All @@ -109,14 +117,21 @@ NSArray<id<FUIAuthProvider>> *providers = @[
[[FUIEmailAuth alloc] init],
[[FUIGoogleAuth alloc] init],
[[FUIFacebookAuth alloc] init],
[[FUIPhoneAuth alloc] initWithAuthUI:[FUIAuth defaultAuthUI]]
[[FUIPhoneAuth alloc] initWithAuthUI:[FUIAuth defaultAuthUI]],
[FUIOAuth appleAuthProvider],
[FUIOAuth twitterAuthProvider],
[FUIOAuth githubAuthProvider],
[FUIOAuth microsoftAuthProvider],
[FUIOAuth yahooAuthProvider]
];
_authUI.providers = providers;
self.authUI.providers = providers;
```

For Google Sign-in support, add custom URL schemes to your Xcode project
(step 1 of the [implement Google Sign-In documentation](https://developers.google.com/firebase/docs/auth/ios/google-signin#2_implement_google_sign-in)).

For Sign in with Apple support, add the Sign in with Apple capability to your entitlements file.

For Facebook Login support, follow step 3 and 4 of
[Facebook login documentation](https://developers.google.com/firebase/docs/auth/ios/facebook-login#before_you_begin),
and follow the [Facebook SDK for iOS Getting started documentation](https://developers.facebook.com/docs/ios/getting-started).
Expand Down
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ FirebaseUI supports iOS 8.0+. We recommend using [CocoaPods](https://cocoapods.o
the following to your `Podfile`:

```ruby
pod 'FirebaseUI', '~> 5.0' # Pull in all Firebase UI features
pod 'FirebaseUI', '~> 8.0' # Pull in all Firebase UI features
```

If you don't want to use all of FirebaseUI, there are multiple subspecs which can selectively install subsets of the full feature set:

```ruby
# Only pull in FirebaseUI Firestore features
# Only pull in Firestore features
pod 'FirebaseUI/Firestore', '~> 8.0'

# Only pull in FirebaseUI Database features
# Only pull in Database features
pod 'FirebaseUI/Database', '~> 8.0'

# Only pull in FirebaseUI Storage features
# Only pull in Storage features
pod 'FirebaseUI/Storage', '~> 8.0'

# Only pull in FirebaseUI Auth features
# Only pull in Auth features
pod 'FirebaseUI/Auth', '~> 8.0'

# Only pull in Facebook login features
Expand Down Expand Up @@ -73,6 +73,7 @@ following commands to get your environment set up:
```bash
$ git clone https://github.com/firebase/FirebaseUI-iOS.git
$ cd FirebaseUI-iOS
$ cd Auth # or PhoneAuth, Database, etc
$ pod install
```

Expand Down