Browse Source

Fix READMEs for auth samples.

Change-Id: I7b4d8aace615504f4896d389996c813693cc2ff9
ryanpbrewster-patch-1
Nicolas Garnier 8 years ago
parent
commit
9d1c2c2699
  1. 16
      instagram-auth/README.md
  2. 18
      linkedin-auth/README.md

16
instagram-auth/README.md

@ -1,18 +1,14 @@
# Use Instagram Sign In with Firebase
This sample shows how to authenticate using Instagram Sign-In on Firebase. In this sample we use OAuth 2.0 based
authentication to get Instagram user information then create a Firebase Custom Token (using the Instagram user ID).
This sample shows how to authenticate using Instagram Sign-In on Firebase. In this sample we use OAuth 2.0 based authentication to get Instagram user information then create a Firebase Custom Token (using the Instagram user ID).
## Setup the sample
Create and setup the Firebase project:
1. Create a Firebase project using the [Firebase Developer Console](https://console.firebase.google.com).
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed for
Firebase Functions.
1. Copy the Web initialisation snippet from **Firebase Console > Overview > Add Firebase to your web app** and paste it
in `public/index.html` and `public/popup.html` in lieu of the placeholders (where the `TODO(DEVELOPER)`
are located).
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed for Firebase Functions.
1. Copy the Web initialisation snippet from **Firebase Console > Overview > Add Firebase to your web app** and paste it in `public/index.html` and `public/popup.html` in lieu of the placeholders (where the `TODO(DEVELOPER)` are located).
Create and provide a Service Account's keys:
1. Create a Service Accounts file as described in the [Server SDK setup instructions](https://firebase.google.com/docs/server/setup#add_firebase_to_your_app).
@ -31,10 +27,8 @@ firebase env:set instagram.clientId="yourClientID" instagram.clientSecret="yourC
> Make sure the Instagram Client Secret is always kept secret. For instance do not save it in your version control system.
Deploy your project:
1. Run `firebase use --add` and choose your Firebase project. This will configure the Firebase CLI to use the correct
project locally.
1. Run `firebase deploy` to effectively deploy the sample. The first time the Functions are deployed the process can
take several minutes.
1. Run `firebase use --add` and choose your Firebase project. This will configure the Firebase CLI to use the correct project locally.
1. Run `firebase deploy` to effectively deploy the sample. The first time the Functions are deployed the process can take several minutes.
## Run the sample

18
linkedin-auth/README.md

@ -1,20 +1,14 @@
# Use LinkedIn Sign In with Firebase
This sample shows how to authenticate using LinkedIn Sign-In on Firebase. In this sample we use OAuth 2.0 based
authentication to get LinkedIn user information then create a Firebase Custom Token (using the LinkedIn user ID).
This sample shows how to authenticate using LinkedIn Sign-In on Firebase. In this sample we use OAuth 2.0 based authentication to get LinkedIn user information then create a Firebase Custom Token (using the LinkedIn user ID).
## Setup the sample
Create and setup the Firebase project:
1. Create a Firebase project using the [Firebase Developer Console](https://console.firebase.google.com).
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed for
Firebase Functions.
1. Copy the Web initialisation snippet from **Firebase Console > Overview > Add Firebase to your web app** and paste it
in `public/index.html` and `public/popup.html` in lieu of the placeholders (where the `TODO(DEVELOPER)`
are located).
1. From Firebse initialization snippet copy the `apiKey` value and paste it in `env.json` for the attribute
`firebaseConfig.apiKey` in lieu of the placeholder.
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed for Firebase Functions.
1. Copy the Web initialisation snippet from **Firebase Console > Overview > Add Firebase to your web app** and paste it in `public/index.html` and `public/popup.html` in lieu of the placeholders (where the `TODO(DEVELOPER)` are located).
Create and provide a Service Account's keys:
1. Create a Service Accounts file as described in the [Server SDK setup instructions](https://firebase.google.com/docs/server/setup#add_firebase_to_your_app).
@ -34,10 +28,8 @@ firebase env:set linkedIn.clientId="yourClientID" linkedIn.clientSecret="yourCli
> Make sure the LinkedIn Client Secret is always kept secret. For instance do not save this in your version control system.
Deploy your project:
1. Run `firebase use --add` and choose your Firebase project. This will configure the Firebase CLI to use the correct
project locally.
1. Run `firebase deploy` to effectively deploy the sample. The first time the Functions are deployed the process can
take several minutes.
1. Run `firebase use --add` and choose your Firebase project. This will configure the Firebase CLI to use the correct project locally.
1. Run `firebase deploy` to effectively deploy the sample. The first time the Functions are deployed the process can take several minutes.
## Run the sample

Loading…
Cancel
Save