https://github.com/app-generator/flask-react-berry-dashboard
Flask React - Berry Dashboard (Free Product) | AppSeed
https://github.com/app-generator/flask-react-berry-dashboard
appseed flask material-ui react
Last synced: 7 months ago
JSON representation
Flask React - Berry Dashboard (Free Product) | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-react-berry-dashboard
- Owner: app-generator
- License: other
- Created: 2021-10-04T09:15:35.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-25T06:33:42.000Z (over 2 years ago)
- Last Synced: 2025-03-11T05:55:50.407Z (7 months ago)
- Topics: appseed, flask, material-ui, react
- Language: Python
- Homepage: https://appseed.us/product/flask-react-berry-dashboard
- Size: 561 KB
- Stars: 18
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask React Berry](https://appseed.us/product/berry-dashboard/api-server-flask/react/) `full-stack`
`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.
The 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).
The **React** Design is crafted by [CodedThemes](https://codedthemes.com/?ref=appseed) on top of `MUI` Library.
- 👉 [Flask React Berry](https://appseed.us/product/berry-dashboard/api-server-flask/react/) - `Product Page`
- 👉 [Flask React Berry](https://flask-react-berry-dashboard.appseed-srv1.com/) - `LIVE Demo`
## ✨ `React` Berry Dashboard
- `M-UI` based design
- Modern aesthetics UI design - Designed by *[CodedThemes](https://bit.ly/37fF9RT)*
- React, Redux, Redux-persist
> `Tests` (compatibility matrix using Ubuntu 18 LTS as reference)
| NodeJS | NPM | YARN |
| --- | --- | --- |
| `v14.0.0` | ✅ | ✅ |
| `v16.0.0` | ✅ | ✅ |
| `v18.0.0` | ❌ | ❌ |
## ✨ `Flask API` Features
- 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
## ✨ How to use it
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:
- [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
### 👉 Start the Frontend
> **Step 1** - Once the project is downloaded, change the directory to `react-ui`.
```bash
$ cd react-ui
```
> **Step 2** - Install dependencies via NPM or yarn
```bash
$ npm i
// OR
$ yarn
```
> **Step 3** - Start in development mode
```bash
$ npm run start
// OR
$ yarn start
```
At this point, the app is available in the browser `localhost:3000` (the default address).
### 👉 Start the Backend Server
> **Step 1** - Change the directory to `api-server-flask`
```bash
$ cd api-server-flask
```
> **Step 2** - Install dependencies using a `virtual environment`
```bash
$ # 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
```
> **Step 3** - Setup the `Flask` environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
// OR
$ (Windows CMD) set FLASK_APP=run.py
$ (Windows CMD) set FLASK_ENV=development
// OR
$ (Powershell) $env:FLASK_APP = ".\run.py"
$ (Powershell) $env:FLASK_ENV = "development"
```
> **Step 4** - Start the API server (development mode)
```bash
$ flask run
```
Use the API via `POSTMAN` or `Swagger Dashboard` at `localhost:5000`.
### 👉 Start API using `Docker`
> **Step 1** - Change the directory to `api-server-flask`
```bash
$ cd api-server-flask
```
> **Step 2** - Start API using `docker-compose` command
```bash
$ docker-compose up --build
```
## 👉 Codebase Structure
```bash
< ROOT >
|
api-server-flask/
├── api
│ ├── config.py
│ ├── __init__.py
│ ├── models.py
│ └── routes.py
├── requirements.txt
├── run.py
└── tests.py
```
## [React Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/full-stack/)
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
Berry 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.
- 👉 [React Berry Dashboard PRO](https://appseed.us/product/berry-dashboard-pro/full-stack/) - Product Page
- ✅ `Enhanced UI` - more pages and components
- ✅ `Priority` on support
---
**[Flask React Berry](https://appseed.us/product/berry-dashboard/api-server-flask/react/)** - `Full-Stack` Seed project generated by **[AppSeed](https://appseed.us)**.