Skip to content

Commit c96029c

Browse files
committed
Update README.md
1 parent 6b7e1c5 commit c96029c

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design
1818
|| **Persistence** | `SQLite`, `MySql` |
1919
|| **Authentication** | Basic, `OAuth` via **AllAuth** for Github |
2020
|| **API Generator** | Secure API via `Flask-restX` |
21-
| | **Dynamic DataTables** | `Server-side` pagination, `Search`, Export |
21+
| | **Dynamic DataTables** | `Server-side` pagination, `Search`, Export |
2222
|| **Stripe Payments** | `One-Time` and `Subscriptions` |
2323
|| **Async Tasks** | via `Celery` |
2424

@@ -151,15 +151,14 @@ At this point, the app runs at `http://127.0.0.1:5000/`.
151151

152152
## ✨ API Generator
153153

154-
This module helps to generate secure APIs using DRF via a simple workflow:
154+
This module helps to generate secure APIs using `Flask-restX` via a simple workflow:
155155

156156
- Edit/add your model in `apps/models.py`
157157
- Migrate the database:
158158

159159
```bash
160-
$ flask shell
161-
>>> from apps import db
162-
>>> db.create_all()
160+
$ flask db init # this should be executed only once
161+
$ flask db migrate # Migrate command should be executed for each DB update
163162
```
164163

165164
- Update Configuration:
@@ -169,7 +168,7 @@ $ flask shell
169168
- Access the API in the browser:
170169
- `/api/MODEL_NAME/`
171170

172-
The API is secured using the JWT mechanism provided by DRF.
171+
The API is secured using the JWT tocken provided by `/login/jwt/` request (username & password should be provided).
173172

174173
- GET requests are public (GET all, get Item)
175174
- Mutating requests are protected by token generated based on the user credentials (`username`, `pass`).

0 commit comments

Comments
 (0)