Skip to content

Commit 252f661

Browse files
committed
update project documentation
1 parent 5305e2d commit 252f661

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,30 @@ $ cd FirebaseUI-iOS
6060
$ pod install
6161
```
6262

63+
## Mandatory Sample Project Configuration
64+
65+
You have to configure Xcode project in order run samples.
66+
67+
1. You project should contain `GoogleService-Info.plist` downloaded from [Firebase console](https://console.firebase.google.com).<br>
68+
Find more instructions and download a plist file from the [Firebase console](https://console.firebase.google.com).
69+
70+
2. Update URL Types.<br>
71+
Go to `Project Settings -> Info tab -> Url Types` and update values for:
72+
+ `REVERSED_CLIENT_ID` (get value from `GoogleService-Info.plist`)
73+
+ `fb{your-app-id}` (put Facebook App Id)
74+
+ `twitterkit-{consumer-key}` (put Twitter App Consumer key)
75+
76+
3. Update `Info.plist` twitter and facebook configuration values
77+
+ `FacebookAppID -> {your-app-id}` (put Facebook App Id)
78+
+ `Fabric -> Kits -> KitInfo -> consumerKey / consumerSecret` (put Twitter App consumer key/secret). Please notice that's it's not secure to store `consumerSecrent` in the app itself.
79+
80+
4. Enable Keychain Sharing.<br>
81+
Facebook SDK requires keychain sharing.<br>
82+
This can be done here: `Project Settings -> Capabilities -> KeyChain Sharing -> ON`
83+
84+
5. Don't forget to configure your Firebase App Database using Firebase Console.<br>
85+
Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectfully)
86+
6387
## Contributing to FirebaseUI
6488

6589
### Contributor License Agreements

samples/objc/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,24 @@ open FirebaseUI-demo-objc.xcworkspace
1818
```
1919
Once you've opened the workspace, go into `Supporting Files/Info.plist` and either fill in the social provider information currently commented out, or delete extra providers you're not interested in. For providers you choose to keep, enable them in your Firebase Dashboard according to the [user authentication docs](https://www.firebase.com/docs/ios/guide/user-auth.html). In `ViewController.m` make sure to only enable providers that you've configured properly.
2020

21+
22+
###Project configuration
23+
24+
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
25+
26+
###Chat Sample
27+
28+
This sample uses [anonymous authentication](https://firebase.google.com/docs/auth/ios/anonymous-auth),
29+
so make sure anonymous auth is enabled in Firebase console.
30+
31+
###Auth Sample
32+
33+
This sample uses [email/password](https://firebase.google.com/docs/auth/ios/password-auth),
34+
[Google](https://firebase.google.com/docs/auth/ios/google-signin),
35+
and [Facebook](https://firebase.google.com/docs/auth/ios/facebook-login)
36+
auth, so make sure those are enabled in Firebase console.
37+
38+
The auth example requires a little more setup (adding url schemes, etc)
39+
since it depends on the various keys and tokens for the different auth
40+
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
41+
for more information.

samples/swift/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ project root and the project should build correctly.
1212
Find more instructions
1313
and download a plist file from the [Firebase console](https://console.firebase.google.com).
1414

15+
###Project configuration
16+
17+
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
18+
1519
###Chat Sample
1620

1721
This sample uses [anonymous authentication](https://firebase.google.com/docs/auth/ios/anonymous-auth),

0 commit comments

Comments
 (0)