Skip to content

Commit ebcaf1e

Browse files
committed
Update README.md
1 parent fb8e00b commit ebcaf1e

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ Start your Development with an Innovative Admin Template for **Material-UI** and
1111
1212
- ✅ Innovative **Soft UI Design** - Crafted by [Creative-Tim](https://bit.ly/3fKQZaL)
1313
- ✅ React, Redux, Redux-persist
14-
- ✅ Authentication: JWT Login/Register/Logout
14+
- ✅ Authentication: `JWT`, `OAuth` via GitHub
15+
- The OAuth feature `can be safely used` with: [Node API](https://github.com/app-generator/api-server-nodejs), and [Node API Mongo](https://github.com/app-generator/api-server-nodejs-mongo)
1516
- ✅ Full-stack ready using **[Node JS API Server](https://appseed.us/boilerplate-code/nodejs-starter/)** (open-source project)
1617
- Features: Typescript / SQLite / TypeORM / Joy (validation) / Passport library - `passport-jwt` strategy.
1718

@@ -64,7 +65,30 @@ $ yarn
6465

6566
<br />
6667

67-
> 👉 **Step #3** - Start in development mode
68+
> 👉 **Step 3** - Edit the `.env` using the template `.env.sample`.
69+
70+
```env
71+
72+
REACT_APP_BACKEND_SERVER='http://localhost:5000/api/'
73+
74+
REACT_APP_GITHUB_OAUTH_CLIENT_ID = ... # Github OAuth Client
75+
REACT_APP_GITHUB_OAUTH_CLIENT_SECRET = ... # Github OAuth Secret
76+
REACT_APP_GITHUB_OAUTH_REDIRECT_URL = ... # Github OAuth Callback URL
77+
```
78+
79+
<br />
80+
81+
> 👉 **Step #4** - Start the app using `HTTPS` (used bu AOuth Callback)
82+
83+
```bash
84+
$ export HTTPS=true # bash
85+
$ set HTTPS=true # Windows/CMD
86+
$env:HTTPS = "true" # Windows/Powershell
87+
```
88+
89+
<br />
90+
91+
> 👉 **Step #5** - Start in development mode
6892
6993
```bash
7094
$ npm run start

0 commit comments

Comments
 (0)