{"id":16175147,"url":"https://github.com/app-generator/flask-react-berry-dashboard","last_synced_at":"2025-03-19T00:31:07.853Z","repository":{"id":100502981,"uuid":"413351946","full_name":"app-generator/flask-react-berry-dashboard","owner":"app-generator","description":"Flask React - Berry Dashboard (Free Product) | AppSeed","archived":false,"fork":false,"pushed_at":"2023-06-25T06:33:42.000Z","size":574,"stargazers_count":18,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-11T05:55:50.407Z","etag":null,"topics":["appseed","flask","material-ui","react"],"latest_commit_sha":null,"homepage":"https://appseed.us/product/flask-react-berry-dashboard","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-04T09:15:35.000Z","updated_at":"2025-02-06T08:18:27.000Z","dependencies_parsed_at":"2024-10-27T19:21:26.529Z","dependency_job_id":"25af6084-a8bf-4dad-9048-da871d8072b5","html_url":"https://github.com/app-generator/flask-react-berry-dashboard","commit_stats":null,"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-berry-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-berry-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-berry-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/app-generator%2Fflask-react-berry-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-berry-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","material-ui","react"],"created_at":"2024-10-10T04:44:14.056Z","updated_at":"2025-03-19T00:31:07.847Z","avatar_url":"https://github.com/app-generator.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Flask React Berry](https://appseed.us/product/berry-dashboard/api-server-flask/react/) `full-stack`\n\n`Full-Stack` starter generated by [React App Generator](https://appseed.us/generator/react/) top of **[Berry Dashboard](https://appseed.us/product/berry-dashboard/api-server-flask/react/)** design. \nThe backend logic is provided by a simple, `easy-to-extend` **Flask API Server** that manages the Authentication flow (login, registration, logout) using `JSON Web Tokens` (JWT). \nThe **React** Design is crafted by [CodedThemes](https://codedthemes.com/?ref=appseed) on top of `MUI` Library.\n\n- 👉 [Flask React Berry](https://appseed.us/product/berry-dashboard/api-server-flask/react/) - `Product Page`\n- 👉 [Flask React Berry](https://flask-react-berry-dashboard.appseed-srv1.com/) - `LIVE Demo`\n\n![React Berry Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/174480640-e0b450b1-07a8-4cc7-84bc-287bb9c45773.png)\n\n\u003cbr \u003e\n\n## ✨ `React` Berry Dashboard\n\n- `M-UI` based design\n- Modern aesthetics UI design - Designed by *[CodedThemes](https://bit.ly/37fF9RT)*\n- React, Redux, Redux-persist\n\n\u003cbr /\u003e\n\n\u003e `Tests` (compatibility matrix using Ubuntu 18 LTS as reference)\n\n| NodeJS | NPM | YARN | \n| --- | --- | --- |  \n| `v14.0.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// OR\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### 👉 Start API using `Docker` \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** - Start API using `docker-compose` command \n\n```bash\n$ docker-compose up --build\n```\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## [React Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/full-stack/)\n\n\u003e For more components, pages and priority on support, feel free to take a look at this amazing starter:\n\nBerry 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, Berry Dashboard PRO is ready to help you create stunning websites and web apps.\n\n- 👉 [React Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/full-stack/) - Product Page\n  - ✅ `Enhanced UI` - more pages and components\n  - ✅ `Priority` on support\n\n\u003cbr \u003e\n\n![React Berry Dashboard PRO - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/174492378-280b6de6-df58-4df7-865d-f86f6e9b1dd0.png)\n\n\u003cbr /\u003e\n\n---\n**[Flask React Berry](https://appseed.us/product/berry-dashboard/api-server-flask/react/)** - `Full-Stack` Seed project generated by **[AppSeed](https://appseed.us)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fflask-react-berry-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapp-generator%2Fflask-react-berry-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapp-generator%2Fflask-react-berry-dashboard/lists"}