Consolidate AuthSamples into main Firebase Xcode project (#288)

1 files changed, 93 insertions, 0 deletions

diff --git a/Example/Auth/README.md b/Example/Auth/README.md
new file mode 100644
index 0000000..499ad00
--- /dev/null
+++ b/Example/Auth/README.md
@@ -0,0 +1,93 @@
+### Running Sample Application
+
+In order to run this application, you'll need to follow the following steps!
+
+#### GoogleService-Info.plist files
+
+You'll need valid `GoogleService-Info.plist` files for those samples. To get your own
+`GoogleService-Info.plist` files:
+1. Go to the [Firebase Console](https://console.firebase.google.com/)
+2. Create a new Firebase project, if you don't already have one
+3. For each sample app you want to test, create a new Firebase app with the sample app's bundle
+identifier (e.g. `com.google.FirebaseExperimental1.dev`)
+4. Download the resulting `GoogleService-Info.plist` and place it in
+[Sample/GoogleService-Info.plist](Sample/GoogleService-Info.plist)
+
+#### GoogleService-Info_multi.plist files
+
+This feature is for advanced testing.
+1. The developer would need to get a GoogleService-Info.plist from a different iOS client (which
+can be in a different Firebase project)
+2. Save this plist file as GoogleService-Info_multi.plist in
+[Sample/GoogleService-Info_multi.plist](Sample/GoogleService-Info_multi.plist).
+This enables testing that FirebaseAuth continues to work after switching the Firebase App in the
+runtime.
+
+#### Application.plist file
+
+Please follow the instructions in
+[Sample/ApplicationTemplate.plist](Sample/ApplicationTemplate.plist)
+to generate the right Application.plist file.
+
+### Sample.entitlements file
+
+In order to test the "Reset Password In App" feature you will need to create a dynamic link for your
+Firebase project in the Dynamic Links section of the Firebase Console. Once the link is created,
+please copy the contents of
+[Sample/SampleTemplate.entitlements](Sample/SampleTemplate.entitlements)
+into a file named `Sample/Sample.entitlements` and replace `$KAPP_LINKS_DOMAIN` with your own
+relevant appLinks domain. Your appLinks domains are domains that your app will handle as universal
+links, in this particular case you can obtain this domain from the aforementioned Dynamic Links
+section of the Firebase Console.
+
+#### Getting your own Credential files
+
+Please follow the instructions in
+[Sample/AuthCredentialsTemplate.h](Sample/AuthCredentialsTemplate.h)
+to generate the AuthCredentials.h file.
+
+
+### Running SwiftSample Application
+
+In order to run this application, you'll need to follow the following steps!
+
+#### GoogleService-Info.plist files
+
+You'll need valid `GoogleService-Info.plist` files for those samples. To get your own
+`GoogleService-Info.plist` files:
+1. Go to the [Firebase Console](https://console.firebase.google.com/)
+2. Create a new Firebase project, if you don't already have one
+3. For each sample app you want to test, create a new Firebase app with the sample app's bundle
+identifier (e.g. `com.google.FirebaseExperimental2.dev`)
+4. Download the resulting `GoogleService-Info.plist` and place it in
+[SwiftSample/GoogleService-Info.plist](SwiftSample/GoogleService-Info.plist)
+
+#### Info.plist file
+
+Please follow the instructions in
+[SwiftSample/InfoTemplate.plist](SwiftSample/InfoTemplate.plist)
+to generate the right Info.plist file
+
+#### Getting your own Credential files
+
+Please follow the instructions in
+[SwiftSample/AuthCredentialsTemplate.swift](SwiftSample/AuthCredentialsTemplate.swift)
+to generate the AuthCredentials.swift file.
+
+### Running API tests
+
+In order to run the API tests, you'll need to follow the following steps!
+
+#### Getting your own Credential files
+
+Please follow the instructions in
+[ApiTests/AuthCredentialsTemplate.h](ApiTests/AuthCredentialsTemplate.h)
+to generate the AuthCredentials.h file.
+
+## Usage
+
+```
+$ pod update
+$ open Firebase.xcworkspace
+```
+Then select an Auth scheme and run.