Skip to content

Commit e6ccdf6

Browse files
committed
Added documentation
1 parent 53d49dd commit e6ccdf6

1 file changed

Lines changed: 88 additions & 1 deletion

File tree

README.md

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Boilerplate with React ⚛️ and Firebase 🔥designed to quickly spin up a ful
2323
- [Unit Testing](#unit-testing)
2424
- [Linting](#linting)
2525
- [Cloud functions](#cloud-functions)
26+
- [Unit Testing](#unit-testing-1)
2627
- [Prerequisites](#prerequisites)
2728
- [Getting started](#getting-started)
2829
- [Setting up the Firebase project locally](#setting-up-the-firebase-project-locally)
@@ -58,8 +59,12 @@ Boilerplate with React ⚛️ and Firebase 🔥designed to quickly spin up a ful
5859
- [How to internationalize a Date](#how-to-internationalize-a-date)
5960
- [How to add your language on DatePicker](#how-to-add-your-language-on-datepicker)
6061
- [File Upload](#file-upload)
61-
- [Image Resize](#image-resize)
62+
- [Image resize extension](#image-resize-extension)
6263
- [Storage Rules](#storage-rules)
64+
- [Authentication via social media accounts](#authentication-via-social-media-accounts)
65+
- [Facebook](#facebook)
66+
- [Google](#google)
67+
- [Microsoft](#microsoft)
6368
- [Contributors](#contributors)
6469
- [License](#license)
6570

@@ -624,6 +629,88 @@ service firebase.storage {
624629
}
625630
```
626631
632+
## Authentication via social media accounts
633+
634+
![Boilerplate - Login](https://i.imgur.com/xQz5pSR.png)
635+
636+
### Facebook
637+
638+
Go to your [Firebase console](https://console.firebase.google.com/), select the proyect, then select Authentication on the Side Bar and Sign-in method. Click the Facebook logo, copy the OAuth redirect URI and keep this window open for later.
639+
640+
Before setting your App id and the App secret on the Facebook Sign-in from the Firebase console, you will need to Log-in into your [Facebook for developers](https://developers.facebook.com/) account, create an app and configure it to make Sign-in via Facebook available.
641+
642+
**Facebook for developers App configuration**
643+
644+
<ol>
645+
<li>Name your App</li>
646+
<li>Click on configure on Log in with Facebook</li>
647+
<li>Choose the Web option </li>
648+
<li>Select Web, set http://localhost:3000 as the URL</li>
649+
<li>Select Product Settings > Facebook Login config on the Side Bar</li>
650+
<li>Put your OAuth redirect URI (the one you copied in the past), you can verify your redirect URI at the buttom of this page</li>
651+
<li>Select Configuration > Basic on the Side Bar</li>
652+
<li>There you got your App id and your App secret for setting them on your proyect from the Firebase console</li>
653+
</ol>
654+
655+
**Facebook for developers App configuration on production**
656+
657+
<ol>
658+
<li>Select Configuration > Basic on the Side Bar</li>
659+
<li>Put your contact email and your privacy policy URL</li>
660+
<li>At the buttom of the page, select Website and change the URL for your domain</li>
661+
<li>Save Changes</li>
662+
<li>Turn on the "on Development" switch</li>
663+
</ol>
664+
665+
**Firebase console**
666+
667+
<ol>
668+
<li>Go to the Firebase Console window from the beggining</li>
669+
<li>Put the App id and the App secret</li>
670+
<li>Enable the Facebook provider</li>
671+
<li>Save</li>
672+
</ol>
673+
674+
For more on this [here](https://firebase.google.com/docs/auth/web/facebook-login).
675+
676+
### Google
677+
678+
For setting your Google authentication you will only need to go to your proyect from the [Firebase console](https://console.firebase.google.com/), then select Authentication on the Side Bar and Sign-in method. Click the Google logo, select a Project support email, enable the Google provider and save.
679+
680+
For more on this [here](https://firebase.google.com/docs/auth/web/google-signin).
681+
682+
### Microsoft
683+
684+
Go to your [Firebase console](https://console.firebase.google.com/), select the proyect, then select Authentication on the Side Bar and Sign-in method. Click the Microsoft logo, copy the redirect URL and keep this window open for later.
685+
686+
Before setting your Application id and the Application secret on the Microsoft Sign-in method from the Firebase console, you will need to log-in into your [Azure](https://portal.azure.com/) account, create an app and configure it to make Sign-in via Microsoft available.
687+
688+
**Azure App configuration**
689+
690+
<ol>
691+
<li>Once you are logged to your account click the left, top corner and select Azure Active Directory</li>
692+
<li>Under Manage, select App registration</li>
693+
<li>Name your App</li>
694+
<li>Specify who can use the application</li>
695+
<li>Put your redirect URL (the one you copied in the past)</li>
696+
<li>Select Register</li>
697+
<li>Select Certificates & secrets from the Side Bar</li>
698+
<li>Select Add a new client secret</li>
699+
<li>Specify expiration time</li>
700+
</ol>
701+
702+
For more on [Register](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) and [configure the app](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-access-web-apis).
703+
704+
**Firebase console**
705+
706+
<li>Go to the Firebase Console window from the beggining</li>
707+
<li>Put the Application id, located on Overview on your Azure App </li>
708+
<li>Put Application secret, located on Certificates & secrets on your Azure App</li>
709+
<li>Enable the Microsoft provider</li>
710+
<li>Save</li>
711+
712+
For more on this [here](https://firebase.google.com/docs/auth/web/microsoft-oauth).
713+
627714
## Contributors
628715
629716
We'd like to thank these awesome people who made this whole thing happen:

0 commit comments

Comments
 (0)