Flask Volt Dashboard PRO

Flask Dashboard coded with basic modules, database, ORM and deployment scripts on top of Volt Dashboard PRO (premium version), a modern Bootstrap dashboard design. Volt Pro is a premium Bootstrap 5 Admin Dashboard featuring over 800 components, 20 example pages and 10 fully customized plugin written in Vanilla Javascript.

• 👉 Volt Dashboard PRO Flask - Product page
• 👉 Volt Dashboard PRO Flask - LIVE Demo
• 👉 Complete documentation - Learn how to use and update the product

Features

• Up-to-date dependencies, active versioning
• DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
• Persistence:
  • SQLite for development - DEBUG=True in .env
  • MySql for production - DEBUG=False in .env
• Authentication
  • Session Based (via flask_login)
  • Social Login (optional) for Github & Twitter
  • Automatic suspension on failed logins
• Users Management
  • Extended user profile
  • Complete Users management (for Admins)
• API via Flask-RestX
  • Path: /api/
  • Products, Sales Models
• Deployment
  • Docker
  • Page Compression via Flask-Minify (for production)

✨ Start the app in Docker

Step 1 - Download and unzip the sources

$ # Get the code
$ unzip flask-volt-dashboard-enh.zip
$ cd flask-volt-dashboard-enh

Step 2 - Start the APP in Docker

$ docker-compose up --build 

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

✨ Create a new .env file using sample env.sample

The meaning of each variable can be found below:

• DEBUG: if True the SQLite persistence is used.
  • For production use False = this will switch to MySql persistence
• Flask environment variables (used in development)
  • FLASK_APP=run.py
  • FLASK_ENV=development
• ASSETS_ROOT: used in assets management
  • default value: /static/assets
• MYSQL credentials (when DEBUG=False)
  • DB_ENGINE, default value = mysql
  • DB_NAME, default value = appseed_db
  • DB_HOST, default value = localhost
  • DB_PORT, default value = 3306
  • DB_USERNAME, default value = appseed_db_usr
  • DB_PASS, default value = pass
• SOCIAL AUTH Github (optional)
  • GITHUB_ID=YOUR_GITHUB_ID
  • GITHUB_SECRET=YOUR_GITHUB_SECRET
• SOCIAL AUTH TWITTER (optional)
  • TWITTER_ID=YOUR_GITHUB_ID
  • TWITTER_SECRET=YOUR_GITHUB_SECRET

✨ Set up the MySql Database

Note: Make sure your Mysql server is properly installed and accessible.

Step 1 - Create the MySql Database to be used by the app

• Create a new MySql database
• Create a new user and assign full privilegies (read/write)

Step 2 - Edit the .env to match your MySql DB credentials. Make sure DB_ENGINE is set to mysql.

• DB_ENGINE : mysql
• DB_NAME : default value = appseed_db
• DB_HOST : default value = localhost
• DB_PORT : default value = 3306
• DB_USERNAME: default value = appseed_db_usr
• DB_PASS : default value = pass

Here is a sample:

# .env sample

DEBUG=False                # False enables the MySql Persistence

DB_ENGINE=mysql            # Database Driver
DB_NAME=appseed_db         # Database Name
DB_USERNAME=appseed_db_usr # Database User
DB_PASS=STRONG_PASS_HERE   # Password 
DB_HOST=localhost          # Database HOST, default is localhost 
DB_PORT=3306               # MySql port, default = 3306 

✨ Manual Build

• Download the code and unzip the sources (requires a purchase).

$ # Get the code
$ unzip flask-volt-dashboard-enh.zip
$ cd flask-volt-dashboard-enh

👉 Set Up for Unix, MacOS

Install modules via VENV

$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Set Up Flask Environment

$ export FLASK_APP=run.py
$ export FLASK_ENV=development

Set Up Database

# Init migration folder
$ flask db init # to be executed only once         

$ flask db migrate # Generate migration SQL
$ flask db upgrade # Apply changes

Create super admin

$ flask create_admin

Start the app

$ flask run

At this point, the app runs at http://127.0.0.1:5000/.

👉 Set Up for Windows

Install modules via VENV (windows)

$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt

Set Up Flask Environment

$ # CMD 
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"

Set Up Database

# Init migration folder
$ flask db init # to be executed only once         

$ flask db migrate # Generate migration SQL
$ flask db upgrade # Apply changes

Create super admin

$ flask create_admin

Start the app

$ flask run

At this point, the app runs at http://127.0.0.1:5000/.

👉 Create (ordinary) Users

By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:

• Start the app via flask run
• Access the registration page and create a new user:
  • http://127.0.0.1:5000/register
• Access the sign in page and authenticate
  • http://127.0.0.1:5000/login

✨ Set up social auth for github

• Homepage URL :
  • http://127.0.0.1:5000/login
• Authorization callback URL :
  • http://127.0.0.1:5000/login/github/authorized

✨ Code-base structure

The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:

< PROJECT ROOT >
   |
   |-- apps/
   |    |
   |    |-- home/                           # A simple app that serve HTML files
   |    |    |-- routes.py                  # Define app routes
   |    |
   |    |-- authentication/                 # Handles auth routes (login and register)
   |    |    |-- routes.py                  # Define authentication routes  
   |    |    |-- models.py                  # Defines models  
   |    |    |-- forms.py                   # Define auth forms (login and register) 
   |    |
   |    |-- static/
   |    |    |-- <css, JS, images>          # CSS files, Javascripts files
   |    |
   |    |-- templates/                      # Templates used to render pages
   |    |    |-- includes/                  # HTML chunks and components
   |    |    |    |-- navigation.html       # Top menu component
   |    |    |    |-- sidebar.html          # Sidebar component
   |    |    |    |-- footer.html           # App Footer
   |    |    |    |-- scripts.html          # Scripts common to all pages
   |    |    |
   |    |    |-- layouts/                   # Master pages
   |    |    |    |-- base-fullscreen.html  # Used by Authentication pages
   |    |    |    |-- base.html             # Used by common pages
   |    |    |
   |    |    |-- accounts/                  # Authentication pages
   |    |    |    |-- login.html            # Login page
   |    |    |    |-- register.html         # Register page
   |    |    |
   |    |    |-- home/                      # UI Kit Pages
   |    |         |-- index.html            # Index page
   |    |         |-- 404-page.html         # 404 page
   |    |         |-- *.html                # All other pages
   |    |    
   |  config.py                             # Set up the app
   |    __init__.py                         # Initialize the app
   |
   |-- requirements.txt                     # App Dependencies
   |
   |-- .env                                 # Inject Configuration via Environment
   |-- run.py                               # Start the app - WSGI gateway
   |
   |-- ************************************************************************

Flask Volt Dashboard PRO - Seed Project generated by AppSeed Generator.