UPD Codebase

Author: app-generator

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2019 - present [AppSeed](http://appseed.us/) / [CodedThemes](https://codedthemes.com/)
+Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
 
 <br />
 
@@ -29,4 +29,4 @@ Copyright (c) 2019 - present [AppSeed](http://appseed.us/) / [CodedThemes](https
 <br />
 
 ---
-For more information regarding licensing, contact the AppSeed Service < *support@appseed.us* >
+For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >

README.md

@@ -1,143 +1,149 @@
-# [Django React Datta Able](https://appseed.us/product/django-react-datta-able)
+# [Django React Datta Able](https://appseed.us/product/datta-able/api-server-django/react/)
 
-Open-source full-stack seed project coded in React and Django on top of a modern design from CodedThemes. The **[Django React](https://appseed.us/product/django-react-datta-able)** codebase is already configured with an SQLite database, API (via **DRF**), 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. 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`
 
-> Features
+![React Datta Able - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/174488189-7bbb3e82-b319-487e-94ec-e295aca3f6d7.png)
 
-- Modern aesthetics UI design - Designed by [CodedThemes](https://bit.ly/37fF9RT)
-- React, Redux, Redux-persist
-- Authentication: JWT Login/Register/Logout
-- Backend: [Django API Server](https://github.com/app-generator/api-server-django) 
+<br >
 
-<br />
+## ✨ `React` Datta Able
 
-> Links
+- Modern aesthetics UI design - Designed by *[CodedThemes](https://bit.ly/37fF9RT)*
+- React, Redux, Redux-persist
 
-- [Django React Datta Able](https://appseed.us/product/django-react-datta-able) - product page
-- [Django React Datta Able](https://django-react-datta-able.appseed-srv1.com/) - LIVE Demo
-- [Django React Datta Able](https://docs.appseed.us/products/react/django-datta-able) - product documentation
-- Download Backend: [Django API Server 📥](https://github.com/app-generator/api-server-django/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)  
+<br />
 
-<br >
+> `Tests` (compatibility matrix)
 
-> **Note**: This product can be used with other API Servers for a complete fullstack experience. **ALL API servers use an unified interface**
+| NodeJS | NPM | YARN | 
+| --- | --- | --- |  
+| `v14.0.0` | ❌ | ✅ |
+| `v16.0.0` | ✅ | ✅ | 
+| `v18.0.0` | ❌ | ❌ | 
 
-- [Flask API Server](https://github.com/app-generator/api-server-flask) - 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)
 
 <br />
 
-![Django React Datta Able - Open-source full stack product built in Django and React.](https://user-images.githubusercontent.com/51070104/127129620-bae3b6b3-eb4f-4ad7-a694-5a3c1d6e37cb.png)
+## ✨ `Django API` Features
+
+- Stack: : `Django` / `DRF` / **SQLite** 
+- `Up-to-date dependencies`
+- **DB Layer**: Django Native `ORM`, `SQLite` persistence
+- **Auth**: JWT tokens managed via `PyJWT`
+- [API Definition](https://docs.appseed.us/boilerplate-code/api-unified-definition) - the unified API structure implemented by this server
 
-<br />
 
-## Start Django API Server
+<br /> 
 
-Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authentication flow is based on [json web tokens](https://jwt.io).
+## ✨ How to use it
 
-> Requirements
+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:
 
-- Django==3.2.5
-- djangorestframework==3.12.4
-- PyJWT==2.1.0
-- django-cors-headers==3.7.0 
+- [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-django.git
-$ cd api-server-django
+$ 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
 ```
 
-**Start the API server** 
+<br />
+
+> **Step 3** - Start in development mode
 
 ```bash
-$ python manage.py migrate
-$ python manage.py runserver 5000
+$ 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.
 
-**Step #1** - Clone the project
+<br /> 
+
+### 👉 Start the Backend Server 
+
+> **Step 1** - Change the directory to `api-server-django`
 
 ```bash
-$ git clone https://github.com/app-generator/react-datta-able-dashboard.git
-$ cd react-datta-able-dashboard
+$ cd api-server-django
 ```
 
 <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 database 
 
 ```bash
-$ npm run start 
-// OR
-$ yarn start
+$ python manage.py makemigrations
+$ python manage.py migrate
 ```
 
 <br />
 
-## Configure the backend server
-
-The product comes with a usable JWT Authentication flow that provides only the basic requests: login/logout/register. 
+> **Step 4** - Start the API server (development mode)
 
-**API Server URL** - `src/config/constant.js` 
-
-```javascript
-const config = {
-    ...
-    API_SERVER: 'http://localhost:5000/api/'  // <-- The magic line
-};
+```bash
+$ python manage.py runserver 5000
 ```
 
+Use the API via `POSTMAN` or `Swagger Dashboard` at `localhost:5000`.
+
 <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 />
 
 ---
-[Django React Datta Able](https://appseed.us/product/django-react-datta-able) - Provided by [CodedThemes](https://codedthemes.com/) and **AppSeed [App Generator](https://appseed.us/app-generator)**.
+**[Django React Datta Able](https://appseed.us/product/datta-able/api-server-django/react/)** - Full-Stack Seed project generated by **[App Generator](https://appseed.us/generator/)**.

api-server-django/.dockerignore

@@ -0,0 +1,4 @@
+env
+.dockerignore
+Dockerfile
+venv

api-server-django/.gitignore

@@ -0,0 +1,130 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.env__