Amo-Addai / flask-material-app

Full-stack platform, with a Python - Flask backend, and a Material UI Frontend Dashboard app

Material Dashboard Flask

Full-stack platform, with a Python - Flask Backend API, and a Material UI Frontend Dashboard app. Comes with a flexible architecture across a variety of devices, operating systems, and databases.

Docker Support

👉 Step 1 - Get the code

$ git clone https://github.com/Amo-Addai/flask-material-app.git
$ cd flask-material-app

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build 

Visit http://localhost:5085 in your browser. The app should be up & running.

Manual Build

👉 Step 1 - Get the code

$ # Get the code
$ git clone https://github.com/Amo-Addai/flask-material-app.git
$ cd flask-material-app
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install modules - SQLite Database
$ pip3 install -r requirements.txt
$
$ # OR with PostgreSQL connector
$ # pip install -r requirements-pgsql.txt
$
$ # Set the FLASK_APP environment variable
$ (Unix/Mac) export FLASK_APP=run.py
$ (Windows) set FLASK_APP=run.py
$ (Powershell) $env:FLASK_APP = ".\run.py"
$
$ # Set up the DEBUG environment
$ # (Unix/Mac) export FLASK_ENV=development
$ # (Windows) set FLASK_ENV=development
$ # (Powershell) $env:FLASK_ENV = "development"
$
$ # Start the application (development mode)
$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
$ # --port=5000    - specify the app port (default 5000)  
$ flask run --host=0.0.0.0 --port=5000
$
$ # Access the dashboard in browser: http://127.0.0.1:5000/

Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.