UPD Developer Tools Section

app-generator · app-generator · commit ccee6c9d55dd · 2023-09-22T11:30:42.000+03:00
diff --git a/docs/developer-tools/_category_.json b/docs/developer-tools/_category_.json
@@ -7,6 +7,6 @@
 	"link": {
 		"type": "generated-index",
 		"slug": "developer-tools",
-		"description": "developer Tools"
+		"description": "Open-source Tools for developers actively supported by AppSeed."
 	}
 }
diff --git a/docs/developer-tools/database-introspection.mdx b/docs/developer-tools/database-introspection.mdx
diff --git a/docs/developer-tools/django-api-generator.mdx b/docs/developer-tools/django-api-generator.mdx
@@ -1,17 +1,18 @@
 ---
-sidebar_position: 1
-description: Developer Tool - Dynamic API Generator
+title:         Django API Generator - Open-Source tool provided by AppSeed
+sidebar_label: Django API Generator
 ---
 
 # Django API Generator
 
-The tool is able to `generate APIs` using **Django & DRF** stack with a minimum effort. For newcomers, **Django** is a leading backend framework used to code from simple websites and APIs to complex eCommerce solutions.
+The tool is able to `generate APIs` using **Django & DRF** stack with a minimum effort. 
+For newcomers, **Django** is a leading backend framework used to code from simple websites and APIs to complex eCommerce solutions.
 
 - 👉 [Django API Generator](https://github.com/app-generator/devtool-django-api-generator) - `Source code`
 - 👉 Free [support](https://appseed.us/support/) via Email and `Discord`
 - 👉 More [Developer Tools](https://appseed.us/developer-tools/) - provided by AppSeed
 
-## Quick start in `Docker`
+## ✅ Quick start in `Docker`
 
 > 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
 
@@ -33,11 +34,11 @@ Visit `http://localhost:5085` in your browser. By default a simple `Books` Model
 
 ![Django API Generator - API View page for Books Model.](https://user-images.githubusercontent.com/51070104/194476781-6476de62-191a-48e8-8730-344c2d63f9d0.png)
 
-## Video Presentation
+## ✅ ideo Presentation
 
 <YoutubeEmbed url="https://www.youtube.com/embed/xREQr9GAsaY" title="Django API Generator - Tools for Developers" />
 
-## How It Works
+## ✅ How It Works
 
 > 👉 **Step #1** - Define models in `apps/models.py`
 
@@ -80,7 +81,10 @@ $ python manage.py generate-api
 - Update book that has id = 2 by `PUT` request to `/api/books/2/`
 - delete book that has id = 2 by `DELETE` request to `/api/books/2/`
 
-## 🚀 Where to go from here
+## ✅ Resources 
+
+- 👉 Access [AppSeed](https://appseed.us/) and start your next project
+- 👉 [Deploy Projects on Aws, Azure and Digital Ocean](https://www.docs.deploypro.dev/) via **DeployPRO**
+- 👉 Create an amazing landing page with [Simpllo, an open-source site builder](https://www.simpllo.com/)
+- 👉 [Django App Generator](https://app-generator.dev/django/) - A 2nd generation App Builder
 
-- 👉 Contact AppSeed using the [support](https://appseed.us/support/) page
-- 👉 Use the [App Generator](https://appseed.us/generator) to generate a new project
diff --git a/docs/developer-tools/django-dynamic-api.mdx b/docs/developer-tools/django-dynamic-api.mdx
@@ -1,18 +1,19 @@
 ---
-sidebar_position: 2
-description: Developer Tool - Dynamic API via Django and DRF
+title:         Django Dynamic API - Open-Source tool provided by AppSeed
+sidebar_label: Django Dynamic API
 ---
 
 # Django Dynamic API
 
 This tool aims to provide a secure, `production-ready API via DRF` (Django REST Framework) using the developer's minimum amount of code. 
 For newcomers, [Django](https://www.djangoproject.com/) is a leading backend framework used to code from simple websites to complex eCommerce solutions. 
+
 [DRF](https://www.django-rest-framework.org/) (Django REST Framework) is the most popular library for developing secure API services.
 
 - 👉 [Django Dynamic API](https://appseed.us/developer-tools/django-dynamic-api/) - product page
 - 👉 [Django Dynamic API](https://www.youtube.com/watch?v=TrTI2jG2LCw) - video presentation
 
-## Tool Specs & Status
+## ✅ Tool Specs & Status
 
 As mentioned above, the **Dynamic API** tool aims to enable a secured API service on top of any Django codebase with a minimum effort. Here are the steps:
 
@@ -28,7 +29,9 @@ A video presentation of this feature can be found on YouTube:
 
 <YoutubeEmbed url="https://www.youtube.com/embed/TrTI2jG2LCw" title="Dynamic API and DataTables - Tools for Developers" />
 
-## 🚀 Where to go from here
+## ✅ Resources 
 
-- 👉 Contact AppSeed using the [support](https://appseed.us/support/) page
-- 👉 Use the [App Generator](https://appseed.us/generator) to generate a new project
+- 👉 Access [AppSeed](https://appseed.us/) and start your next project
+- 👉 [Deploy Projects on Aws, Azure and Digital Ocean](https://www.docs.deploypro.dev/) via **DeployPRO**
+- 👉 Create an amazing landing page with [Simpllo, an open-source site builder](https://www.simpllo.com/)
+- 👉 [Django App Generator](https://app-generator.dev/django/) - A 2nd generation App Builder
diff --git a/docs/developer-tools/django-dynamic-datatables.mdx b/docs/developer-tools/django-dynamic-datatables.mdx
diff --git a/docs/developer-tools/flask-dynamic-api.mdx b/docs/developer-tools/flask-dynamic-api.mdx
@@ -1,8 +1,118 @@
 ---
-sidebar_position: 4
-description: Developer Tool - Dynamic API via Flask-RestX
+title:         Flask Dynamic API - Open-Source tool provided by AppSeed
+sidebar_label: Flask Dynamic API
 ---
 
 # Flask Dynamic API
 
-@Todo
+This tool aims to provide a secure, `production-ready API via Flask-RestX` using the developer's minimum amount of code. 
+For newcomers, **Flask** is a leading backend framework used to code from simple websites and API's to complex eCommerce solutions.
+
+**Flask-RestX** is a popular library for developing secure API services using Flask.
+
+- 👉 Free [support](https://appseed.us/support/) via Email and [Discord](https://discord.gg/fZC6hup)
+- 👉 More [Developer Tools](https://appseed.us/developer-tools/) - provided by AppSeed
+
+## ✅ Video Presentation
+
+<YoutubeEmbed url="https://user-images.githubusercontent.com/51070104/194328733-3bdf8c70-f765-4168-983d-2a51e276239b.mp4" title="Flask Dynamic API - Open-Source tool provided by AppSeed" />
+
+
+## ✅ Manual Build 
+
+> Clone/Download Sources
+
+```bash
+$ git clone https://github.com/app-generator/flask-dynamic-api.git
+$ cd flask-dynamic-api
+```
+
+> Install Modules
+
+```bash
+$ virtualenv env
+$ source env/bin/activate
+$ pip install -r requirements.txt
+```
+
+> Update ENV 
+
+```bash
+$ export FLASK_APP=run.py
+```
+
+> Migrate DB 
+
+```bash
+$ flask db init     # INIT needs to be executed only once
+$ flask db migrate  # Needs to be executed at each DB Schema Update  
+$ flask db upgrade  # Needs to be executed at each DB Schema Update
+```
+
+> Start the project
+
+```bash
+$ flask run
+```
+
+## ✅ How it works
+
+The **Dynamic API** tool aims to enable a secured API service on top of any Flask codebase with a minimum effort. Here are the steps:
+
+- `Define a new model` in the project (an old one can be also used)
+- `Execute the database migration` to create/update the associated tables
+- `Update the configuration` to enable the Dynamic API over the model
+- `Start the app`
+- Access the `Dynamic API Service`
+
+For instance, if the new model managed by the Dynamic API is called books, the associate API is exposed at /api/books/
+
+<br />
+
+| Status | Item | info | 
+| --- | --- | --- |
+| ✅ | New Models Definition in `apps/models` | - |
+| ✅ | The app is saved in `apps/dyn_api` | - |
+| ✅ | Models enabled in `apps/config.py` via `DYNAMIC_API` variable | - |
+| ✅ | The project exposes automatically a CRUD API over the new model | - |
+| ✅ | Path of the service: `/api/books/` | In case the new model is `Books` | 
+| ✅ | The API is powered via Flask-RestX using best practices | - | 
+
+
+## ✅ API Permissions
+
+Before using the API, the user must make a request to the `/login' endpoint and send his username and password.:
+
+```json
+POST /login
+{
+  "username": "my_username",
+  "password": "my_password"
+}
+```
+
+The server returns a token if approved.
+
+```json
+{
+  "token": "RETURNED_TOKEN"
+}
+```
+
+To use the features, the user must add a key and value to the headers.
+
+headers of requests:
+```json
+{
+  ...
+  "Authorization": "token RETURNED_TOKEN"
+  ...
+}
+```
+**Note:** token will be expired after 24 hours.
+
+## ✅ Resources 
+
+- 👉 Access [AppSeed](https://appseed.us/) and start your next project
+- 👉 [Deploy Projects on Aws, Azure and Digital Ocean](https://www.docs.deploypro.dev/) via **DeployPRO**
+- 👉 Create an amazing landing page with [Simpllo, an open-source site builder](https://www.simpllo.com/)
diff --git a/docs/developer-tools/flask-dynamic-datatables.mdx b/docs/developer-tools/flask-dynamic-datatables.mdx
@@ -1,17 +1,20 @@
 ---
-sidebar_position: 5
-description: Developer Tool - Dynamic DataTables via Flask
+title:         Flask Dynamic DataTables - Open-Source tool provided by AppSeed
+sidebar_label: Flask Dynamic DataTables
 ---
 
 # Flask Dynamic DataTables
 
-The tool aims to provide a powerful data table interface using the developer's minimum amount of code For newcomers, Flask is a leading backend framework used to code from simple websites and APIs to complex eCommerce solutions. The presentation layer uses `Simple-DataTables` and Vanilla JS code to render the information.
+The tool aims to provide a powerful data table interface using the developer's minimum amount of code. 
+For newcomers, Flask is a leading backend framework used to code from simple websites and APIs to complex eCommerce solutions. 
+
+The presentation layer uses `Simple-DataTables` and Vanilla JS code to render the information.
 
 - 👉 [Flask Dynamic DataTables](https://github.com/app-generator/devtool-flask-dynamic-datatb) - source code (MIT License)
 - 👉 Free [support](https://appseed.us/support/) via Email and [Discord](https://discord.gg/fZC6hup)
 - 👉 More [Developer Tools](https://appseed.us/developer-tools/) - provided by AppSeed
 
-### Tool Specs & Status
+## ✅ Tool Specs & Status
 
 As mentioned above, the `Dynamic DataTables` tool aims to enable a powerful data table interface on top of any Flask codebase with a minimum effort. Here are the steps:
 
@@ -27,7 +30,8 @@ A video presentation of this feature can be found on YouTube:
 
 <YoutubeEmbed url="https://www.youtube.com/embed/kYRvhQj-JQE" title="Flask Dynamic DataTables - Free Tool for Developers" />
 
-## 🚀 Where to go from here
+## ✅ Resources 
 
-- 👉 Contact AppSeed using the [support](https://appseed.us/support/) page
-- 👉 Use the [App Generator](https://appseed.us/generator) to generate a new project
+- 👉 Access [AppSeed](https://appseed.us/) and start your next project
+- 👉 [Deploy Projects on Aws, Azure and Digital Ocean](https://www.docs.deploypro.dev/) via **DeployPRO**
+- 👉 Create an amazing landing page with [Simpllo, an open-source site builder](https://www.simpllo.com/)

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,6 @@`
`7`	`7`	`"link": {`
`8`	`8`	`"type": "generated-index",`
`9`	`9`	`"slug": "developer-tools",`
`10`		`- "description": "developer Tools"`
	`10`	`+ "description": "Open-source Tools for developers actively supported by AppSeed."`
`11`	`11`	`}`
`12`	`12`	`}`