{"id":14065667,"url":"https://github.com/app-generator/flask-react-soft-dashboard","last_synced_at":"2025-03-19T00:31:08.373Z","repository":{"id":51912535,"uuid":"415516645","full_name":"app-generator/flask-react-soft-dashboard","owner":"app-generator","description":"Flask React - Soft Dashboard (Open-source) | AppSeed.us","archived":false,"fork":false,"pushed_at":"2023-03-29T11:45:47.000Z","size":6235,"stargazers_count":24,"open_issues_count":1,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-11T05:55:50.493Z","etag":null,"topics":["appseed","flask","react","soft-dashboard"],"latest_commit_sha":null,"homepage":"https://appseed.us/product/soft-ui-dashboard/api-server-flask/react/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/app-generator.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-10T07:31:58.000Z","updated_at":"2025-03-01T07:45:56.000Z","dependencies_parsed_at":"2024-05-28T01:37:01.875Z","dependency_job_id":"f474d725-e81d-4c7d-902e-38593f2fac51","html_url":"https://github.com/app-generator/flask-react-soft-dashboard","commit_stats":null,"previous_names":[],"tags_count":3,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-soft-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-soft-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-soft-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-soft-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/app-generator","download_url":"https://codeload.github.com/app-generator/flask-react-soft-dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243955700,"owners_count":20374373,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appseed","flask","react","soft-dashboard"],"created_at":"2024-08-13T07:04:37.470Z","updated_at":"2025-03-19T00:31:06.559Z","avatar_url":"https://github.com/app-generator.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# [React Soft Ui Dashboard](https://appseed.us/product/soft-ui-dashboard/api-server-flask/react/) `full-stack`\n\nFull-Stack Seed project generated by **[React App Generator](https://appseed.us/generator/react/)** top of *Soft Ui Dashboard* 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).\n\n- 👉 [Flask React Soft UI Dashboard](https://appseed.us/product/soft-ui-dashboard/api-server-flask/react/) - `product page`\n- 👉 [Flask React Soft UI Dashboard](https://flask-react-soft-dashboard.appseed-srv1.com/authentication/sign-in) - `LIVE Demo`\n- ✅ [Flask React Soft UI Dashboard](https://www.youtube.com/watch?v=gwWfahWPt2A) - `YouTube material` \n\n\u003cbr /\u003e\n\n\u003e Features\n\n- ✅ Innovative **Material UI** Design - Crafted by [Creative-Tim](https://bit.ly/3fKQZaL)\n- ✅ React, Redux, Redux-persist\n- ✅ Authentication: JWT Login/Register/Logout\n- ✅ **Full-stack Ready** using a **Flask API Server** (open-source project) - Server Features\n  - Flask / Flask-RestX / SQLite3 - a simple, easy to use backend\n  - Authentication with JWT (login, logout, register)\n  - Docker, Unitary tests\n\n\u003cbr /\u003e\n  \n## ✨ `Video Presentation`\n\n\u003e This material explains how to build the project using the [App Generator](https://appseed.us/generator/react/) and deploy with [LIVE Deployer](https://appseed.us/go-live/) service.\n\nhttps://user-images.githubusercontent.com/51070104/202889957-ea8f6808-7a72-45ec-91f7-4a02b19e63d9.mp4\n\n\u003cbr /\u003e\n\n## ✨ `React` Soft UI Dashboard\n\n- `M-UI` based design crafted by *[Creative-Tim](https://bit.ly/3fKQZaL)*\n- `UI Kit`: 70+ components, `8 Sample Pages`, `3 Customized Plugins`\n\n\u003cbr /\u003e\n\n\u003e `Tests` (compatibility matrix)\n\n| NodeJS | NPM | YARN | \n| --- | --- | --- |  \n| `v14.15.0` | ✅ | ✅ |\n| `v16.0.0` | ✅ | ✅ | \n| `v18.0.0` | ❌ | ❌ | \n\n\n\u003cbr /\u003e\n\n## ✨ `Flask API` Features\n\n- Stack: `Flask` / `Flask-RestX` / **SQLite** \n- **DB Layer**: `SqlAlchemyORM`, `SQLite` persistence\n- **Auth**: JWT tokens managed via `Flask-jwt_extended`\n- [API Definition](https://docs.appseed.us/boilerplate-code/api-unified-definition) - the unified API structure implemented by this server\n\n\n\u003cbr /\u003e \n\n## ✨ How to use it\n\nBeing a full-stack product, the backend and the frontend should be compiled and started separately. \nBefore starting to compile the product, make sure you have the following tools installed in the environment:\n\n- [NodeJS](https://nodejs.org/en/) - version `14.x` or higher\n- [GIT](https://git-scm.com/) - used to clone tjhe sources from Github\n- [Python3](https://www.python.org/) - used in many tools\n\n\u003cbr /\u003e\n\n### 👉 Start the Frontend \n\n\u003e **Step 1** - Once the project is downloaded, change the directory to `react-ui`. \n\n```bash\n$ cd react-ui\n```\n\n\u003cbr \u003e\n\n\u003e **Step 2** - Install dependencies via NPM or yarn\n\n```bash\n$ npm i\n// OR\n$ yarn\n```\n\n\u003cbr /\u003e\n\n\u003e **Step 3** - Start in development mode\n\n```bash\n$ npm run start \n// OR\n$ yarn start\n```\n\n\u003cbr /\u003e\n\nAt this point, the app is available in the browser `localhost:3000` (the default address).\n\n\u003cbr /\u003e \n\n### 👉 Start the Backend Server \n\n\u003e **Step 1** - Change the directory to `api-server-flask`\n\n```bash\n$ cd api-server-flask\n```\n\n\u003cbr \u003e\n\n\u003e **Step 2** - Install dependencies using a `virtual environment`\n\n```bash\n$ # Virtualenv modules installation (Unix based systems)\n$ virtualenv env\n$ source env/bin/activate\n$\n$ # Virtualenv modules installation (Windows based systems)\n$ # virtualenv env\n$ # .\\env\\Scripts\\activate\n$\n$ pip install -r requirements.txt\n```\n\n\u003cbr /\u003e\n\n\u003e **Step 3** - Setup the `Flask` environment \n\n```bash\n$ export FLASK_APP=run.py\n$ export FLASK_ENV=development\n// OR \n$ (Windows CMD) set FLASK_APP=run.py\n$ (Windows CMD) set FLASK_ENV=development\n$\n$ (Powershell) $env:FLASK_APP = \".\\run.py\"\n$ (Powershell) $env:FLASK_ENV = \"development\"\n```\n\n\u003cbr /\u003e\n\n\u003e **Step 4** - Start the API server (development mode)\n\n```bash\n$ flask run\n```\n\nUse the API via `POSTMAN` or `Swagger Dashboard` at `localhost:5000`.\n\n\u003cbr /\u003e \n\n## 👉 Codebase Structure\n\n```bash\n\u003c ROOT  \u003e\n    |\n   api-server-flask/\n    ├── api\n    │   ├── config.py\n    │   ├── __init__.py\n    │   ├── models.py\n    │   └── routes.py\n    ├── requirements.txt\n    ├── run.py\n    └── tests.py\n```\n\n\u003cbr /\u003e\n\n## PRO Version\n\n\u003e For more components, pages and priority on support, feel free to take a look at this amazing starter:\n\nSoft UI Dashboard 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, Soft UI Dashboard PRO is ready to help you create stunning websites and web apps.\n\n- 👉 [React Soft UI Dashboard PRO](https://appseed.us/product/soft-ui-dashboard-pro/full-stack/) - Product Page\n  - ✅ `Enhanced UI` - more pages and components\n  - ✅ `Priority` on support\n\n\u003cbr \u003e\n\n![Soft UI Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/170829870-8acde5af-849a-4878-b833-3be7e67cff2d.png)\n\n\u003cbr /\u003e\n\n---\n[React Soft Dashboard](https://appseed.us/product/soft-ui-dashboard/api-server-flask/react/) - Full-Stack Seed project generated by **[App Generator](https://appseed.us/generator/)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fflask-react-soft-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fflask-react-soft-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fflask-react-soft-dashboard/lists"}