Skip to content

Cleaning up FirebaseUI IOS sample READMEs #256

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 1 commit into from
Mar 3, 2017
Merged

Cleaning up FirebaseUI IOS sample READMEs #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,10 @@ Alternatively you can use `pod try FirebaseUI` to install the Objective-C or Swi

## Mandatory Sample Project Configuration

You have to configure Xcode project in order to run samples.
You have to configure your Xcode project in order to run samples.

1. You project should contain `GoogleService-Info.plist` downloaded from [Firebase console](https://console.firebase.google.com).<br>
Copy `GoogleService-Info.plist` into sample project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).<br>
Find more instructions and download a plist file from the [Firebase console](https://console.firebase.google.com).
1. Your Xcode project should contain `GoogleService-Info.plist`, downloaded from [Firebase console](https://console.firebase.google.com) when you add your app to a Firebase project.<br>
Copy `GoogleService-Info.plist` into sample the project folder (`samples/obj-c/GoogleService-Info.plist` or `samples/swift/GoogleService-Info.plist`).

2. Update URL Types.<br>
Go to `Project Settings -> Info tab -> Url Types` and update values for:
Expand All @@ -87,7 +86,7 @@ Facebook SDK requires keychain sharing.<br>
This can be done here: `Project Settings -> Capabilities -> KeyChain Sharing -> ON`

5. Don't forget to configure your Firebase App Database using [Firebase console](https://console.firebase.google.com).<br>
Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectfully)
Database should contain appropriate read/write permissions and folders (`objc_demo-chat` and `swift_demo-chat` respectively)

## Contributing to FirebaseUI

Expand Down
13 changes: 9 additions & 4 deletions samples/objc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FirebaseUI Chat Demo
====================
FirebaseUI Chat Demo in Objective C
===================================

This is a super simple FirebaseUI Chat demo. It shows:
This is a super simple FirebaseUI Chat demo in Objective C. It shows:
1. The ease of integrating with FirebaseUI
1. Using a `UITableView` outside of a `UITableViewController`
1. Using custom XIBs in FirebaseUI to achieve a custom look and feel
Expand All @@ -20,7 +20,7 @@ Once you've opened the workspace, go into `Supporting Files/Info.plist` and eith

###Project configuration

Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run the sample project.

###Chat Sample

Expand All @@ -38,3 +38,8 @@ The auth example requires a little more setup (adding url schemes, etc)
since it depends on the various keys and tokens for the different auth
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
for more information.

###Storage Sample

This sample does not use a logged-in user, so make to set up the [Storage Security Rules](https://firebase.google.com/docs/storage/security/start#sample-rules)
for your bucket to allow that.
24 changes: 17 additions & 7 deletions samples/swift/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
Swift Samples
-----
FirebaseUI Chat Demo in Swift
=============================

This directory contains a collection of swift code samples.

###Project configuration

Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
In order to install and run:
``` bash
git clone https://github.com/firebase/FirebaseUI-iOS.git
cd FirebaseUI-iOS/samples/swift
pod install
open FirebaseUI-demo-swift.xcworkspace
```
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.

###Project configuration

Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run sample project.
Please follow steps described [here](https://github.com/firebase/FirebaseUI-iOS#mandatory-sample-project-configuration) in order to run the sample project.

###Chat Sample

Expand All @@ -25,5 +30,10 @@ auth, so make sure those are enabled in Firebase console.

The auth example requires a little more setup (adding url schemes, etc)
since it depends on the various keys and tokens for the different auth
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
services your app will support. Take a look at the [Auth README](../../FirebaseAuthUI/README.md)
for more information.

###Storage Sample
Copy link
Contributor

@morganchen12 morganchen12 Mar 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this section in particular!


This sample does not use a logged-in user, so make to set up the [Storage Security Rules](https://firebase.google.com/docs/storage/security/start#sample-rules)
for your bucket to allow that.