app-generator / flask-react-soft-dashboard

Flask React - Soft Dashboard (Open-source) | AppSeed.us

Home Page:https://appseed.us/product/soft-ui-dashboard/api-server-flask/react/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Full-Stack Seed project generated by React App Generator 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).


Features

  • βœ… Innovative Material UI Design - Crafted by Creative-Tim
  • βœ… React, Redux, Redux-persist
  • βœ… Authentication: JWT Login/Register/Logout
  • βœ… Full-stack Ready using a Flask API Server (open-source project) - Server Features
    • Flask / Flask-RestX / SQLite3 - a simple, easy to use backend
    • Authentication with JWT (login, logout, register)
    • Docker, Unitary tests

✨ Video Presentation

This material explains how to build the project using the App Generator and deploy with LIVE Deployer service.

react-flask-soft-ui-dashboard.mp4

✨ React Soft UI Dashboard

  • M-UI based design crafted by Creative-Tim
  • UI Kit: 70+ components, 8 Sample Pages, 3 Customized Plugins

Tests (compatibility matrix)

NodeJS NPM YARN
v14.15.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 - 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 - version 14.x or higher
  • GIT - used to clone tjhe sources from Github
  • Python3 - used in many tools

πŸ‘‰ Start the Frontend

Step 1 - Once the project is downloaded, change the directory to react-ui.

$ cd react-ui

Step 2 - Install dependencies via NPM or yarn

$ npm i
// OR
$ yarn

Step 3 - Start in development mode

$ 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

$ cd api-server-flask

Step 2 - Install dependencies using a virtual environment

$ # 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

$ 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"

Step 4 - Start the API server (development mode)

$ flask run

Use the API via POSTMAN or Swagger Dashboard at localhost:5000.


πŸ‘‰ Codebase Structure

< ROOT  >
    |
   api-server-flask/
    β”œβ”€β”€ api
    β”‚   β”œβ”€β”€ config.py
    β”‚   β”œβ”€β”€ __init__.py
    β”‚   β”œβ”€β”€ models.py
    β”‚   └── routes.py
    β”œβ”€β”€ requirements.txt
    β”œβ”€β”€ run.py
    └── tests.py

PRO Version

For more components, pages and priority on support, feel free to take a look at this amazing starter:

Soft 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.


Soft UI Dashboard PRO - Starter generated by AppSeed.



React Soft Dashboard - Full-Stack Seed project generated by App Generator.

About

Flask React - Soft Dashboard (Open-source) | AppSeed.us

https://appseed.us/product/soft-ui-dashboard/api-server-flask/react/

License:Other


Languages

Language:Python 77.4%Language:HTML 10.9%Language:JavaScript 7.4%Language:Dockerfile 4.3%