Skip to content

Commit 13395da

Browse files
committed
README - Update DOCS
1 parent 5e68874 commit 13395da

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Simple [Flask API Boilerplate](https://appseed.us/boilerplate-code/flask-api-boi
88
99
-`Up-to-date dependencies`
1010
-[API Definition](https://docs.appseed.us/boilerplate-code/api-unified-definition) - the unified API structure implemented by this server
11-
-`Flask-restX`, `Flask-jwt_extended`
11+
- ✅ API powered by `Flask-restX`
12+
-`JWT Authentication` (login, logout, register) via `Flask-jwt_extended`
13+
-`OAuth` for **Github**
1214
-**Docker**, `Unitary tests`
1315
- 🚀 `Instant Deploy` on RENDER using [Python Deployer](https://github.com/app-generator/deploy-automation-render)
1416
- `python.exe deployer.py flask <THIS_REPO> "run:app"`
@@ -107,11 +109,15 @@ $ (Powershell) $env:FLASK_ENV = "development"
107109

108110
<br />
109111

110-
> **Step #5** - set `.env` for GitHub social login
111-
```bash
112-
$ GITHUB_CLIENT_ID=
113-
$ GITHUB_CLIENT_SECRET=
114-
```
112+
> **Step #5** - Create a new `.env` file using sample `env.sample`
113+
114+
The meaning of each variable can be found below:
115+
116+
- `DEBUG`: if `True` the app runs in develoment mode
117+
- For production value `False` should be used
118+
- `SECRET_KEY`: used in assets management
119+
- `GITHUB_CLIENT_ID`: For GitHub social login
120+
- `GITHUB_SECRET_KEY`: For GitHub social login
115121

116122
<br />
117123

0 commit comments

Comments
 (0)