Skip to content

Commit bf2b348

Browse files
committed
Update README.md
1 parent ac22256 commit bf2b348

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Open-source **Django Dashboard** generated by `AppSeed` op top of a modern desig
1818
|| **Persistence** | `SQLite`, `MySql` |
1919
|| **Authentication** | Basic, `OAuth` via **AllAuth** for Github |
2020
|| **API Generator** | Secure API via DRF - **[Video Presentation](https://youtu.be/IM-PJrlgBe8)** |
21-
| | **Dynamic DataTables** | [read more](https://appseed.us/developer-tools/django-dynamic-datatables/) |
21+
| | **Dynamic DataTables** | [read more](https://appseed.us/developer-tools/django-dynamic-datatables/) |
2222
|| **Payments** | `One-Time` and `Subscriptions` via `Stripe` |
2323
|| **Async Tasks** | via `Celery` |
2424

@@ -96,8 +96,8 @@ $ pip3 install -r requirements.txt
9696
9797
```bash
9898
$ python manage.py makemigrations
99-
$ python manage.py makemigrations apps
10099
$ python manage.py migrate
100+
$ python manage.py generate-api # optional
101101
```
102102

103103
<br />
@@ -131,6 +131,7 @@ $ pip3 install -r requirements.txt
131131
```bash
132132
$ python manage.py makemigrations
133133
$ python manage.py migrate
134+
$ python manage.py generate-api # optional
134135
```
135136

136137
<br />
@@ -153,10 +154,12 @@ This module helps to generate secure APIs using DRF via a simple workflow:
153154

154155
- Edit/add your model in `apps/models.py`
155156
- Migrate the database:
156-
- `$ python manage.py makemigrations apps` # this will generate the new SQL
157-
- `$ python manage.py migrate` # this will apply the changes
157+
- `python manage.py makemigrations apps` # this will generate the new SQL
158+
- `python manage.py migrate` # this will apply the changes
159+
- Update Configuration:
160+
- `core/settings.py`, section `API_GENERATOR`
158161
- Generate the API code:
159-
- `$ python manage.py generate-api` # the new code is saved in `apps/api`
162+
- `python manage.py generate-api` # the new code is saved in `apps/api`
160163
- Access the API in the browser:
161164
- `/api/MODEL_NAME/`
162165

@@ -169,6 +172,21 @@ The API is secured using the JWT mechanism provided by DRF.
169172
170173
<br />
171174

175+
## ✨ Dynamic DataTables
176+
177+
This module helps to generate dynamic view for all models defined in `apps/models.py`. How to use it:
178+
179+
- Edit/add your model in `apps/models.py`
180+
- Migrate the database:
181+
- `python manage.py makemigrations` # this will generate the new SQL
182+
- `python manage.py migrate` # this will apply the changes
183+
- Update Configuration:
184+
- `core/settings.py`, section `DYNAMIC_DATATB`
185+
- Access the dynamic view in the browser:
186+
- `/datatb/MODEL_NAME/`
187+
188+
<br />
189+
172190
## ✨ Create Users
173191

174192
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:

0 commit comments

Comments
 (0)