Document API Generator usage

Author: app-generator

README.md

@@ -8,21 +8,22 @@ Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern design
 
 <br />
 
-> 🚀 Built with [Able Generator](https://appseed.us/generator/)
-
-- `Up-to-date dependencies`, active versioning
-- `DB Tools`: SQLAlchemy ORM, `Flask-Migrate` (schema migrations)
-- `Persistence`:
-  - `SQLite` for development - `DEBUG=True` in `.env`
-  - `MySql` for production - `DEBUG=False` in `.env` 
-- `Authentication`
-  - Session Based (via **flask_login**)
-  - `Social Login` (optional) for **Github**
-- `Deployment`
-  - `Docker`, HEROKU
-  - Page Compression via `Flask-Minify` (for production)
-- `Dark Mode` (enhancement)
-  - Persistent via browser `local storage`
+> Roadmap & Features 
+
+| Status | Item | info | 
+| --- | --- | --- |
+| ✅ | **Up-to-date Dependencies** | Tested with Django `v3.2.x`, `v4.x` |
+| ✅ | **UI Kit** | `Bootstrap 5`, `Dark-Mode` (persistent) |
+| ✅ | **Docker** | Simple Setup (local usage) |
+| ✅ | **Persistence** | `SQLite`, `MySql` |
+| ✅ | **Authentication** | Basic, `OAuth` via **AllAuth** for Github |
+| ✅ | **API Generator** | Secure API via `Flask-restX` |
+| ✅ | **Dynamic DataTables** | `Server-side` pagination, `Search`, Export |
+| ❌ | **Stripe Payments** | `One-Time` and `Subscriptions` |
+| ❌ | **Async Tasks** | via `Celery` |
+
+
+> Something is missing? Submit a new `product feature request` using the [issues tracker](https://github.com/app-generator/flask-soft-ui-dashboard/issues).
 
 <br />
 
@@ -148,6 +149,35 @@ At this point, the app runs at `http://127.0.0.1:5000/`.
 
 <br />
 
+## ✨ API Generator
+
+This module helps to generate secure APIs using DRF via a simple workflow: 
+
+- Edit/add your model in `apps/models.py`
+- Migrate the database:
+
+```bash
+$ flask shell
+>>> from apps import db
+>>> db.create_all()
+```
+
+- Update Configuration:
+  - `apps/config .py`, section `API_GENERATOR` 
+- Generate the API code:
+  - `$ flask gen_api`        # the new code is saved in `apps/api`
+- Access the API in the browser:
+  - `/api/MODEL_NAME/`
+
+The API is secured using the JWT mechanism provided by DRF.  
+
+- GET requests are public (GET all, get Item)
+- Mutating requests are protected by token generated based on the user credentials (`username`, `pass`). 
+
+> A POSTMAN Collection Sample can be found [here](./media).
+
+<br />
+
 ### 👉 Create Users
 
 By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: