Update Codebase

Author: app-generator

LICENSE.md

@@ -0,0 +1,32 @@
+# MIT License
+
+Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
+
+<br />
+
+## Licensing Information
+
+<br />
+
+| Item | - |
+| ---------------------------------- | --- |
+| License Type | MIT  |
+| Use for print | **YES** |
+| Create single personal website/app | **YES** |
+| Create single website/app for client | **YES** |
+| Create multiple website/apps for clients | **YES** |
+| Create multiple SaaS applications | **YES** |
+| End-product paying users | **YES** |
+| Product sale | **YES** |
+| Remove footer credits | **YES** |
+| --- | --- |
+| Remove copyright mentions from source code | NO |
+| Production deployment assistance | NO |
+| Create HTML/CSS template for sale | NO |
+| Create Theme/Template for CMS for sale | NO |
+| Separate sale of our UI Elements | NO |
+
+<br />
+
+---
+For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >

README.md

@@ -1,136 +1,173 @@
-# [Flask React Datta Able](https://appseed.us/product/flask-react-datta-able)
+# [Flask React Datta Able](https://appseed.us/product/datta-able/api-server-flask/react/)
 
-Open-source full-stack seed project coded in React and Flask on top of a modern design from CodedThemes. The **[Flask React](https://appseed.us/product/flask-react-datta-able)** codebase is already configured with an SQLite database, API (via **Flask-RextX**), and JWT token-based authentication flow. **Datta Able** is an open-source **React Dashboard** that provides a colorful and modern design. 
+Full-Stack Seed project generated by **[React App Generator](https://appseed.us/generator/react/)** top of *Datta Able* design from **[CodedThemes](https://codedthemes.com/?ref=appseed)**.
+The backend logic is provided by a simple, `easy-to-extend` API Server that manages the Authentication flow (login, registration, logout) using `JSON Web Tokens` (JWT).
 
-<br />
+- 👉 [Flask React Datta Able](https://appseed.us/product/datta-able/api-server-flask/react/) - `Product Page`
+- 👉 [Flask React Datta Able](https://flask-react-datta-able.appseed-srv1.com) - `LIVE Demo`
+
+![React Datta Able - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/174488189-7bbb3e82-b319-487e-94ec-e295aca3f6d7.png)
+
+<br >
 
-> Features
+## ✨ `React` Datta Able
 
-- Modern aesthetics UI design - Designed by [CodedThemes](https://bit.ly/37fF9RT)
+- Modern aesthetics UI design - crafted by *[CodedThemes](https://bit.ly/37fF9RT)*
 - React, Redux, Redux-persist
-- Authentication: JWT Login/Register/Logout
-- Backend: [Flask API Server](https://github.com/app-generator/api-server-flask) 
 
 <br />
 
-> Links
+> `Tests` (compatibility matrix)
 
-- [Flask React Datta Able](https://appseed.us/product/flask-react-datta-able) - product page
-- [Flask React Datta Able](https://flask-react-datta-able.appseed-srv1.com/) - LIVE Demo
-- [Flask React Datta Able](https://docs.appseed.us/products/react/flask-datta-able) - product documentation
-- Download Backend: [Flask API Server 📥](https://github.com/app-generator/api-server-flask/archive/refs/heads/main.zip)
-- Donwnload Frontend: [React Datta Able 📥](https://github.com/app-generator/react-node-js-datta-able/archive/refs/heads/main.zip)  
+| NodeJS | NPM | YARN | 
+| --- | --- | --- |  
+| `v14.0.0` | ❌ | ✅ |
+| `v16.0.0` | ✅ | ✅ | 
+| `v18.0.0` | ❌ | ❌ | 
 
-<br >
 
-> **Note**: This product can be used with other API Servers for a complete fullstack experience. **ALL API servers use an unified interface**
+<br />
+
+## ✨ `Flask API` Features
 
-- [Django API Server](https://github.com/app-generator/api-server-django) - open-source product
-- [Node JS API Server](https://github.com/app-generator/api-server-nodejs) - open-source product / Typescript / SQLite / TypeORM / Joy for validation
-- [Node JS API Server PRO](https://github.com/app-generator/api-server-nodejs-pro) - **commercial product**
-    - SQLite / TypeORM / Joy / Docker
-    - MongoDB / Mongoose / Joy Docker (separate branch, same project)
+- Stack: `Flask` / `Flask-RestX` / **SQLite** 
+- **DB Layer**: `SqlAlchemyORM`, `SQLite` persistence
+- **Auth**: JWT tokens managed via `Flask-jwt_extended`
+- [API Definition](https://docs.appseed.us/boilerplate-code/api-unified-definition) - the unified API structure implemented by this server
 
-<br />
 
-![Flask React Datta Able - Open-source full stack product built in Flask and React.](https://user-images.githubusercontent.com/51070104/127129620-bae3b6b3-eb4f-4ad7-a694-5a3c1d6e37cb.png)
+<br /> 
 
-<br />
+## ✨ How to use it
 
-## Start Flask API Server
+Being a full-stack product, the backend and the frontend should be compiled and started separately. 
+Before starting to compile the product, make sure you have the following tools installed in the environment:
 
-Simple starter built with Python / Flask-RestX / Sqlite3 and JWT Auth. The authentication flow is based on [json web tokens](https://jwt.io).
+- [NodeJS](https://nodejs.org/en/) - version `14.x` or higher
+- [GIT](https://git-scm.com/) - used to clone tjhe sources from Github
+- [Python3](https://www.python.org/) - used in many tools
 
 <br />
 
-> How to use the code
+### 👉 Start the Frontend 
 
-**Clone the sources**
+> **Step 1** - Once the project is downloaded, change the directory to `react-ui`. 
 
 ```bash
-$ git clone https://github.com/app-generator/api-server-flask.git
-$ cd api-server-flask
+$ cd react-ui
 ```
 
-**Create a virtual environment**
-
-```bash
-$ virtualenv -p python3 venv
-$ source venv/bin/activate
-```
+<br >
 
-**Install dependencies** using pip
+> **Step 2** - Install dependencies via NPM or yarn
 
 ```bash
-$ pip install -r requirements.txt
+$ npm i
+// OR
+$ yarn
 ```
 
-**Set up the environment** 
+<br />
+
+> **Step 3** - Start in development mode
 
 ```bash
-$ export FLASK_APP=run.py
-$ export FLASK_ENV=development
+$ npm run start 
+// OR
+$ yarn start
 ```
 
-The API server will start using the default port `5000`. 
-
 <br />
 
-## Start React UI 
+At this point, the app is available in the browser `localhost:3000` (the default address).
+
 
-To use the product Node JS (>= 12.x) is required and GIT to clone/download the project from the public repository.
+<br /> 
 
-**Step #1** - Clone the project
+### 👉 Start the Backend Server 
+
+> **Step 1** - Change the directory to `api-server-flask`
 
 ```bash
-$ git clone https://github.com/app-generator/react-datta-able-dashboard.git
-$ cd react-datta-able-dashboard
+$ cd api-server-flask
 ```
 
 <br >
 
-**Step #2** - Install dependencies via NPM or yarn
+> **Step 2** - Install dependencies using a `virtual environment`
 
 ```bash
-$ npm i
-// OR
-$ yarn
+$ # Virtualenv modules installation (Unix based systems)
+$ virtualenv env
+$ source env/bin/activate
+$
+$ # Virtualenv modules installation (Windows based systems)
+$ # virtualenv env
+$ # .\env\Scripts\activate
+$
+$ pip install -r requirements.txt
 ```
 
 <br />
 
-**Step #3** - Start in development mode
+> **Step 3** - Setup the `Flask` environment 
 
 ```bash
-$ npm run start 
-// OR
-$ yarn start
+$ export FLASK_APP=run.py
+$ export FLASK_ENV=development
+// OR 
+$ (Windows CMD) set FLASK_APP=run.py
+$ (Windows CMD) set FLASK_ENV=development
+$
+$ (Powershell) $env:FLASK_APP = ".\run.py"
+$ (Powershell) $env:FLASK_ENV = "development"
 ```
 
 <br />
 
-## Configure the backend server
+> **Step 4** - Start the API server (development mode)
+
+```bash
+$ flask run
+```
+
+Use the API via `POSTMAN` or `Swagger Dashboard` at `localhost:5000`.
 
-The product comes with a usable JWT Authentication flow that provides only the basic requests: login/logout/register. 
+<br /> 
 
-**API Server URL** - `src/config/constant.js` 
+## 👉 Codebase Structure
 
-```javascript
-const config = {
-    ...
-    API_SERVER: 'http://localhost:5000/api/'  // <-- The magic line
-};
+```bash
+< ROOT  >
+    |
+   api-server-flask/
+    ├── api
+    │   ├── config.py
+    │   ├── __init__.py
+    │   ├── models.py
+    │   └── routes.py
+    ├── requirements.txt
+    ├── run.py
+    └── tests.py
 ```
 
 <br />
 
-**API Server Descriptor** - POSTMAN Collection
+## [React Datta Able PRO](https://appseed.us/product/datta-able-pro/full-stack/)
+
+> For more components, pages and priority on support, feel free to take a look at this amazing starter:
+
+Datta Able is a premium React Design now available for download as a full-stack app. Made of hundred of elements, designed blocks, and fully coded pages, Datta Able PRO is ready to help you create stunning websites and web apps.
 
-The backend server uses an [Unified API defition](https://docs.appseed.us/boilerplate-code/api-server/api-unified-definition) maintained and actively supported by AppSeed across multiple frameworks: Flask, Node JS, FastAPI.
+- 👉 [React Datta Able PRO](https://appseed.us/product/datta-able-pro/full-stack/) - Product Page
+  - ✅ `Enhanced UI` - more pages and components
+  - ✅ `Priority` on support
+
+<br >
 
-- [API POSTMAN Collection](https://github.com/app-generator/api-unified-definition/blob/main/api.postman_collection.json) - can be used to mock (simulate) the backend server or code a new one in your preferred framework. 
+![React Datta Able PRO - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/174492290-a581dc5f-6b4a-4f5e-822e-419a8b96a480.png)
 
 <br />
 
 ---
-[Flask React Datta Able](https://appseed.us/product/flask-react-datta-able) - Provided by [CodedThemes](https://codedthemes.com/) and **AppSeed [App Generator](https://appseed.us/app-generator)**.
+[Flask React Datta Able](https://appseed.us/product/datta-able/api-server-flask/react/) - Full-Stack Seed project generated by **[AppSeed](https://appseed.us/)**.

api-server-flask/.env

@@ -0,0 +1,18 @@
+DEBUG=True
+
+FLASK_APP=run.py
+FLASK_ENV=development
+
+# SECRET_KEY=...        # edit value, (generated used if not provided)
+# JWT_SECRET_KEY=...    # edit value, (generated used if not provided)
+
+# GITHUB_CLIENT_ID=...  # edit value
+# GITHUB_SECRET_KEY=... # edit value 
+
+# If DB credentials (if NOT provided, or wrong values SQLite is used) 
+# DB_ENGINE=mysql
+# DB_HOST=localhost
+# DB_NAME=appseed_db
+# DB_USERNAME=appseed_db_usr
+# DB_PASS=pass
+# DB_PORT=3306

api-server-flask/.gitignore

@@ -0,0 +1,11 @@
+flask/
+*.pyc
+dev
+api/apidata.db
+yarn.lock
+yarn-error.log
+*.psd
+env/
+env__/
+.vscode/symbols.json
+app/db.sqlite3

api-server-flask/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Change Log
+
+## [v1.0.4] 2023-02-11
+### Changes
+
+- Codebase Improvements
+  - Sync with [Flask API](https://github.com/app-generator/api-server-flask) `v1.0.7`
+- `DB Management` Improvement
+  - `Silent fallback` to **SQLite**
+
+## [1.0.3] 2022-11-05
+### Improvements
+
+- Updated for Deploy on RENDER using [Python Deployer](https://github.com/app-generator/deploy-automation-render)
+  - `python.exe .\deployer.py flask https://github.com/app-generator/api-server-flask`
+  - The new API is usable via `https://api-server-flask-<RANDOM>.onrender.com/api/`
+
+## [1.0.2] 2022-06-07
+### Improvements
+
+- Update dependencies 
+
+## [1.0.1] 2021-11-16
+### Improvements
+
+- Tables automatic creation
+- Dependencies Update:
+  - Flask==2.0.2
+  - flask-restx==0.5.1
+- Docker Scripts   
+
+## [1.0.0] 2021-07-20
+### Stable release
+
+- Persistance: SQLite3  
+- Stack: Flask / Flask-JWT-Extended / SQLAlchemy
+- API:
+   - Sign UP: `/api/users/register`
+   - Sign IN: `/api/users/login`
+   - Logout: `/api/users/logout`
+

api-server-flask/Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.9
+
+COPY . .
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# install python dependencies
+RUN pip install --upgrade pip
+RUN pip install --no-cache-dir -r requirements.txt
+
+# gunicorn
+CMD ["gunicorn", "--config", "gunicorn-cfg.py", "run:app"]

api-server-flask/LICENSE.md

@@ -0,0 +1,26 @@
+# MIT License
+
+Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+<br />
+
+---
+For more information regarding licensing, please contact AppSeed < *support @ appseed.us* >