You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[React Datta Able PRO](https://appseed.us/product/datta-able-pro/full-stack/react/) - commercial product
27
-
:::tip
28
-
For more information or support please access the [AppSeed](https://appseed.us) platform or chat directly with support team on [Discord](https://appseed.us/support).
Copy file name to clipboardExpand all lines: docs/boilerplate-code/api-server/django.mdx
+54-19Lines changed: 54 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,7 @@ import SubHeading from "@site/src/components/SubHeading";
11
11
12
12
Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is based on **json web tokens**. The product comes with a simple, intuitive codebase, DRF integration, SQLite for persistence JWT Authentication API, Docker, and unitary tests.
13
13
14
-
:::info Version
15
-
16
-
[**v1.0.2**](https://github.com/app-generator/api-server-django/releases), release date `2022-06-07`
14
+
:::info [**v1.0.6**](https://github.com/app-generator/api-server-django/releases) - release date `Dec 8, 2022`
17
15
:::
18
16
19
17
-[API Definition](api-unified-definition.mdx) - the unified API structure implemented by this server
@@ -22,7 +20,9 @@ Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authe
> API Methods - for full description please access [API Unified Definition](api-unified-definition.mdx)
23
+
<br />
24
+
25
+
> **API Interface** - for full description please access [API Unified Definition](api-unified-definition.mdx)
26
26
27
27
- USERS API:
28
28
-`/api/users/register`: create a new user
@@ -31,18 +31,20 @@ Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authe
31
31
-`/api/users/checkSession`: check an existing JWT Token for validity
32
32
-`/api/users/edit` - edit the information associated with a registered user
33
33
34
-
34
+
[](https://docs.appseed.us/boilerplate-code/api-server/django/)
35
+
35
36
36
-
## ✨ Requirements
37
+
## Requirements
37
38
38
-
-**Python3** (Python2 is not supported)
39
-
-**Django**==3.2.13
40
-
-**djangorestframework**==3.13.1
41
-
-**PyJWT**==2.4.0
42
-
-**django-cors-headers**==3.13.0
43
-
-**gunicorn**==20.1.0 (used by the Docker set up)
39
+
-`Python3` (Python2 is not supported)
40
+
-`Django`==3.2.13
41
+
-`djangorestframework`==3.13.1
42
+
-`PyJWT`==2.4.0
43
+
-`django-cors-headers`==3.13.0
44
+
-`gunicorn`==20.1.0 (used by the Docker set up)
44
45
45
-
## ✨ How to use the code
46
+
47
+
## How to use the code
46
48
47
49
> 👉 **Step 1** - Clone the sources
48
50
@@ -73,7 +75,8 @@ $ python manage.py runserver
73
75
74
76
The API server will start using the default port `8000`.
75
77
76
-
## ✨ **Docker execution**
78
+
79
+
## **Docker execution**
77
80
78
81
> 👉 **Step 1** - Get the code
79
82
@@ -90,11 +93,43 @@ $ docker-compose up -d --build
90
93
91
94
Visit `http://localhost:5000` in your browser. The API server will be running
92
95
93
-
## ✨ Compatible Fullstack Products
94
96
95
-
The product can be used as a standalone server but also as an authentication server for React, Vue products. Such a product already configured with Django API Server is [**React Datta Able**](https://appseed.us/product/datta-able/api-server-nodejs/react/)**,** an open-source React Dashboard.
`React Soft Dashboard` is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
102
+
The product comes with a simple JWT authentication flow: login/register/logout.
103
+
The **React** Design is crafted by [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200) on top of `MUI` Library.
`Full-Stack` Seed project generated by [React App Generator](https://appseed.us/generator/react/) top of **[Berry Dashboard](https://appseed.us/product/berry-dashboard/api-server-django/react/)** design.
Copy file name to clipboardExpand all lines: docs/boilerplate-code/api-server/flask.mdx
+52-18Lines changed: 52 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,7 @@ description: Open-source API Server crafted in Flask using JWT Authentication an
10
10
11
11
Simple [Flask API Boilerplate](https://appseed.us/boilerplate-code/flask-api-boilerplate) enhanced with JWT authentication, SqlAlchemy, **SQLite** persistence and deployment scripts via Docker. It has all the ready-to-use bare minimum essentials.
12
12
13
-
:::info Version
14
-
15
-
[**v1.0.2**](https://github.com/app-generator/api-server-flask/releases), release date `2022-06-07`
13
+
:::info [**v1.0.7**](https://github.com/app-generator/api-server-flask/releases) - release date `Feb 11, 2023`
16
14
:::
17
15
18
16
-[API Definition](api-unified-definition.mdx) - the unified API structure implemented by this server
@@ -21,7 +19,9 @@ Simple [Flask API Boilerplate](https://appseed.us/boilerplate-code/flask-api-boi
> API Methods - for full description please access [API Unified Definition](api-unified-definition.mdx)
22
+
<br />
23
+
24
+
> **API Interface** - for full description please access [API Unified Definition](api-unified-definition.mdx)
25
25
26
26
- USERS API:
27
27
-`/api/users/register`: create a new user
@@ -30,17 +30,19 @@ Simple [Flask API Boilerplate](https://appseed.us/boilerplate-code/flask-api-boi
30
30
-`/api/users/checkSession`: check an existing JWT Token for validity
31
31
-`/api/users/edit` - edit the information associated with a registered user
32
32
33
-
33
+
[](https://docs.appseed.us/boilerplate-code/api-server/flask/)
34
+
34
35
35
-
## ✨ Requirements
36
+
## Requirements
36
37
37
-
-**Python3** (Python2 is not supported)
38
-
-**Flask**==2.1.2
39
-
-**flask-restx**==0.5.1
40
-
-**Flask-JWT-Extended**==4.4.1
41
-
- pytest
38
+
-`Python3` (Python2 is not supported)
39
+
-`Flask`==2.1.2
40
+
-`flask-restx`==0.5.1
41
+
-`Flask-JWT-Extended`==4.4.1
42
+
-`pytest`
42
43
43
-
## ✨ Getting Started
44
+
45
+
## Getting Started
44
46
45
47
> 👉 **Step 1** - clone the project using GIT
46
48
@@ -97,7 +99,8 @@ $ flask run
97
99
98
100
Visit `http://localhost:5000` in your browser. The API server will be running.
99
101
100
-
## ✨ Project Structure
102
+
103
+
## Project Structure
101
104
102
105
The codebase has a simple, intuitive structure where `run.py` is responsible to bundle and start the API Server using the setup coded by the `api` folder:
`Full-Stack` Seed project generated by [React App Generator](https://appseed.us/generator/react/) top of **[Berry Dashboard](https://appseed.us/product/berry-dashboard/api-server-django/react/)** design.
`React Soft Dashboard` is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
149
+
The product comes with a simple JWT authentication flow: login/register/logout.
150
+
The **React** Design is crafted by [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200) on top of `MUI` Library.
The product can be used as a standalone server but also as an authentication server for React, Vue products. Such a product already configured with Django API Server is [**React Datta Able**](https://appseed.us/product/datta-able/api-server-nodejs/react/)**,** an open-source React Dashboard.
> API Methods - for full description please access [API Unified Definition](api-unified-definition.mdx)
23
+
<br />
24
+
25
+
> **API Interface** - for full description please access [API Unified Definition](api-unified-definition.mdx)
26
26
27
27
- USERS API:
28
28
-`/api/users/register`: create a new user
@@ -31,17 +31,19 @@ Free API Server coded on top of Express / Node JS with **SQLite** persistence an
31
31
-`/api/users/checkSession`: check an existing JWT Token for validity
32
32
-`/api/users/edit` - edit the information associated with a registered user
33
33
34
-
34
+
[](https://docs.appseed.us/boilerplate-code/api-server/node-js/)
35
+
35
36
36
-
## ✨ Tests Matrix
37
+
> Tested with:
37
38
38
-
| NodeJS | NPM | YARN | Status |
39
-
| ----------| ---------| ----------|------ |
40
-
|`v17.0.0`|`v8.11.0`|`v1.22.18`| ✔️ |
41
-
|`v16.15.1`|`v8.11.0`|`v1.22.18`|✔️ |
42
-
|`v16.13.0`|`v8.1.0`|`v1.22.5`| ✔️ |
39
+
| NodeJS | NPM | YARN |
40
+
| --- | --- | --- |
41
+
|`v18.0.0`|✅|✅|
42
+
|`v16.10.0`|✅|✅ |
43
+
|`v14.15.0`|✅ | ✅ |
43
44
44
-
## ✨ How to use the code
45
+
46
+
## How to use the code
45
47
46
48
> 👉 **Step 1** - Clone the sources
47
49
@@ -88,9 +90,10 @@ $ npm start
88
90
$ yarn start
89
91
```
90
92
91
-
The API server will start using the `PORT` specified in `.env` file (default 5000)\\
93
+
The API server will start using the `PORT` specified in `.env` file (default 5000)
94
+
92
95
93
-
## ✨ Codebase Structure
96
+
## Codebase Structure
94
97
95
98
```
96
99
< ROOT / src >
@@ -116,7 +119,8 @@ The API server will start using the `PORT` specified in `.env` file (default 500
`React Soft Dashboard` is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
146
+
The product comes with a simple JWT authentication flow: login/register/logout.
147
+
The **React** Design is crafted by [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200) on top of `MUI` Library.
`Full-Stack` Seed project generated by [React App Generator](https://appseed.us/generator/react/) top of **[Berry Dashboard](https://appseed.us/product/berry-dashboard/api-server-django/react/)** design.
- 👉 [Django React Berry](https://django-react-berry-dashboard.appseed-srv1.com/) - LIVE Demo
171
+
172
+
138
173
139
-
The product can be used as a standalone server but also as an authentication server for React, Vue products. Such a product already configured with Django API Server is [**React Datta Able**](https://appseed.us/product/datta-able/api-server-nodejs/react/)**,** an open-source React Dashboard.
0 commit comments