Skip to content

Commit 700ff58

Browse files
committed
improve README.md
1 parent fed6886 commit 700ff58

File tree

1 file changed

+53
-13
lines changed

1 file changed

+53
-13
lines changed

README.md

Lines changed: 53 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build Status](https://travis-ci.org/the-road-to-react-with-firebase/react-firestore-authentication.svg?branch=master)](https://travis-ci.org/the-road-to-react-with-firebase/react-firestore-authentication) [![Slack](https://slack-the-road-to-learn-react.wieruch.com/badge.svg)](https://slack-the-road-to-learn-react.wieruch.com/) [![Greenkeeper badge](https://badges.greenkeeper.io/the-road-to-react-with-firebase/react-firestore-authentication.svg)](https://greenkeeper.io/)
44

55
* [Tutorial for React Firebase but not Firestore](https://www.robinwieruch.de/complete-firebase-authentication-react-tutorial/)
6-
* [Live Version of half of the Tutorial](https://react-firestore-authentication.wieruch.com/)
6+
* [Live Version of half of the Tutorial](https://react-firebase-authentication.wieruch.com/)
77

88
## Features
99

@@ -50,15 +50,55 @@ If you are creating an open source application under a license compatible with t
5050
* `cd react-firestore-authentication`
5151
* `npm install`
5252
* `npm start`
53-
* visit http://localhost:3000/
54-
* Use your own Firebase Credentials
55-
56-
### Use your own Firebase Credentials
57-
58-
* visit https://firebase.google.com and create a Firebase App
59-
* copy and paste your Credentials from your Firebase App into *src/components/Firebase/firebase.js* file or in .env file
60-
* [activate Sign-In Methods in your Firebase App](https://www.robinwieruch.de/react-firebase-social-login/)
61-
* Email/Password
62-
* Google
63-
* Facebook
64-
* Twitter
53+
* visit http://localhost:3000
54+
55+
Get an overview of Firebase, how to create a project, what kind of features Firebase offers, and how to navigate through the Firebase project dashboard in this [visual tutorial for Firebase](https://www.robinwieruch.de/firebase-tutorial/).
56+
57+
### Firebase Configuration
58+
59+
* copy/paste your configuration from your Firebase project's dashboard into one of these files
60+
* *src/components/Firebase/firebase.js* file
61+
* *.env* file
62+
* *.env.development* and *.env.production* files
63+
64+
The *.env* or *.env.development* and *.env.production* files could look like the following then:
65+
66+
```
67+
REACT_APP_API_KEY=AIzaSyBtxZ3phPeXcsZsRTySIXa7n33NtQ
68+
REACT_APP_AUTH_DOMAIN=react-firebase-s2233d64f8.firebaseapp.com
69+
REACT_APP_DATABASE_URL=https://react-firebase-s2233d64f8.firebaseio.com
70+
REACT_APP_PROJECT_ID=react-firebase-s2233d64f8
71+
REACT_APP_STORAGE_BUCKET=react-firebase-s2233d64f8.appspot.com
72+
REACT_APP_MESSAGING_SENDER_ID=701928454501
73+
```
74+
75+
### Activate Sign-In Methods
76+
77+
![firebase-enable-google-social-login_640](https://user-images.githubusercontent.com/2479967/49687774-e0a31e80-fb42-11e8-9d8a-4b4c794134e6.jpg)
78+
79+
* Email/Password
80+
* [Google](https://www.robinwieruch.de/react-firebase-social-login/)
81+
* [Facebook](https://www.robinwieruch.de/firebase-facebook-login/)
82+
* [Twitter](https://www.robinwieruch.de/firebase-twitter-login/)
83+
* [Troubleshoot](https://www.robinwieruch.de/react-firebase-social-login/)
84+
85+
### Activate Verification E-Mail
86+
87+
* add a redirect URL for redirecting a user after an email verification into one of these files
88+
* *src/components/Firebase/firebase.js* file
89+
* *.env* file
90+
* *.env.development* and *.env.production* files
91+
92+
The *.env* or *.env.development* and *.env.production* files could look like the following then (excl. the Firebase configuration).
93+
94+
**Development:**
95+
96+
```
97+
REACT_APP_CONFIRMATION_EMAIL_REDIRECT=http://localhost:3000
98+
```
99+
100+
**Production:**
101+
102+
```
103+
REACT_APP_CONFIRMATION_EMAIL_REDIRECT=https://mydomain.com
104+
```

0 commit comments

Comments
 (0)