Flask Volt PRO
Premium Flask Starter coded on top Volt PRO Bootstrap 5 design (Premium Version).
Flask Admin Dashboard generated by the AppSeed platform on top of Volt PRO Dashboard Design (premium version) crafted by Themesberg.
Version: v1.0.13 - release date 2022-06-12
  • Built with Volt Dashboard Generator​
  • DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
  • Session-Based authentication (via flask_login), Forms validation
  • Deployment scripts: Docker, Gunicorn/Nginx
Links
Volt Dashboard PRO - Starter generated by AppSeed.

✨ Environment

To use the starter, Python3 should be installed properly in the workstation. If you are not sure if Python is installed, please open a terminal and type python --version. Here is the full list with dependencies and tools required to build the app:
  • ​Python3 - the programming language used to code the app
  • ​GIT - used to clone the source code from the Github repository
  • Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
  • (Optional) Docker - a popular virtualization software

✨ Start the app in Docker

πŸ‘‰ Step 1 - Download the code and unzip the sources (requires a purchase).
1
$ # Get the code
2
$ unzip flask-volt-dashboard-pro.zip
3
$ cd flask-volt-dashboard-pro
Copied!
πŸ‘‰ Step 2 - Start the APP in Docker
1
$ docker-compose up --build
Copied!
Visit http://localhost:5085 in your browser. The app should be up & running.

✨ Manual Build

Download the code and unzip the sources (requires a purchase).
1
$ # Get the code
2
$ unzip flask-volt-dashboard-pro.zip
3
$ cd flask-volt-dashboard-pro
Copied!

πŸ‘‰ Set Up for Unix, MacOS

Install modules via VENV
1
$ virtualenv env
2
$ source env/bin/activate
3
$ pip3 install -r requirements.txt
Copied!
Set Up Flask Environment
1
$ export FLASK_APP=run.py
2
$ export FLASK_ENV=development
Copied!
Start the app
1
$ flask run
Copied!
At this point, the app runs at http://127.0.0.1:5000/.

πŸ‘‰ Set Up for Windows

Install modules via VENV (windows)
1
$ virtualenv env
2
$ .\env\Scripts\activate
3
$ pip3 install -r requirements.txt
Copied!
Set Up Flask Environment
1
$ # CMD
2
$ set FLASK_APP=run.py
3
$ set FLASK_ENV=development
4
$
5
$ # Powershell
6
$ $env:FLASK_APP = ".\run.py"
7
$ $env:FLASK_ENV = "development"
Copied!
Start the app
1
$ flask run
Copied!
At this point, the app runs at http://127.0.0.1:5000/.

✨ Manage App Users

By default, the starter is not provided with users.

πŸ‘‰ Create 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

✨ Codebase structure

The project is coded using a simple and intuitive structure presented below:
1
< PROJECT ROOT >
2
|
3
|-- apps/
4
| |
5
| |-- home/ # A simple app that serve HTML files
6
| | |-- routes.py # Define app routes
7
| |
8
| |-- authentication/ # Handles auth routes (login and register)
9
| | |-- routes.py # Define authentication routes
10
| | |-- models.py # Defines models
11
| | |-- forms.py # Define auth forms (login and register)
12
| |
13
| |-- static/
14
| | |-- <css, JS, images> # CSS files, Javascripts files
15
| |
16
| |-- templates/ # Templates used to render pages
17
| | |-- includes/ # HTML chunks and components
18
| | | |-- navigation.html # Top menu component
19
| | | |-- sidebar.html # Sidebar component
20
| | | |-- footer.html # App Footer
21
| | | |-- scripts.html # Scripts common to all pages
22
| | |
23
| | |-- layouts/ # Master pages
24
| | | |-- base-fullscreen.html # Used by Authentication pages
25
| | | |-- base.html # Used by common pages
26
| | |
27
| | |-- accounts/ # Authentication pages
28
| | | |-- login.html # Login page
29
| | | |-- register.html # Register page
30
| | |
31
| | |-- home/ # UI Kit Pages
32
| | |-- index.html # Index page
33
| | |-- page-404.html # 404 page
34
| | |-- *.html # All other pages
35
| |
36
| config.py # Set up the app
37
| __init__.py # Initialize the app
38
|
39
|-- requirements.txt # App Dependencies
40
|
41
|-- .env # Inject Configuration via Environment
42
|-- run.py # Start the app - WSGI gateway
43
|
44
|-- ************************************************************************
Copied!

✨ Application Bootstrap Flow

The entry point of the project is the run.py file where the project configuration is bundled. The most important files that make the project functional are listed below:
  • run.py is the application entry point
    • read the Debug flag from .env
    • import the db object from apps package
    • import the create_app helper from apps
  • Flask application is built by create_app
    • If Debug=True - SQLite is used (development mode)
    • If Debug=False - SQLite is used (production mode)
  • Configuration
    • is defined in apps/config.py

✨ How the Flask App object is constructed

The file that constructs the core features of our application is apps/__init__.py. The most important steps are listed below:
  • Invokes SQLAlchemy to build the db object.
    • Using SQLAlchemy we can manage the database information with ease
  • Invokes LoginManager to build the login_manager object.
    • login_manager manage the authentication layer (login, logout, register)
  • Defines create_app helper that does the following:
    • create the Flask app object
    • injects db and login_manager objects
    • loads the configuration
    • register default blueprints:
      • authentication - handles the authentication routes
      • home - serve all the pages saved in the apps/templates/home folder
    • initialize the database
      • db.create_all() - create all tables

✨ Application Blueprints

The codebase is built using a modular design that uses blueprints. By default, the project comes with a two blueprints

πŸ‘‰ Authentication Blueprint

Definition: apps/authentication. The core files:
  • __init__.py - defines the Blueprint object
  • models.py - defines the Users model
  • forms.py - defines the Login and Registration forms
  • utils.py - helpers used to hass and verify the password
  • routes - manages the authentication routes:
    • login
    • register
    • logout

πŸ‘‰ Home Blueprint

This module returns all pages saved in the templates/home directory to authenticated users. In case a page is not found, a generic page is returned using a 404 HTTP error status.

✨ UI Assets and Templates

The project comes with a modern UI fully migrated and usable with Django Template Engine.

πŸ‘‰ Page Templates

All pages and components are saved inside the apps/templates directory. Here are the standard directories:
  • templates/layouts: UI masterpages
  • templates/includes: UI components (used across multiple pages)
  • templates/accounts: login & registration page
  • templates/home: all other pages served via a generic routing by apps/home app
1
< PROJECT ROOT >
2
|
3
|-- apps/
4
| |
5
| |-- home/ # A simple app that serve HTML files
6
| |-- authentication/ # Handles auth routes (login and register)
7
| |
8
| |-- static/
9
| | |-- <css, JS, images> # CSS files, Javascripts files
10
| |
11
| |-- templates/ # Templates used to render pages
12
| |-- includes/ # HTML chunks and components
13
| | |-- navigation.html # Top menu component
14
| | |-- footer.html # App Footer
15
| | |-- scripts.html # Scripts common to all pages
16
| |
17
| |-- layouts/ # Master pages
18
| | |-- base.html # Used by common pages
19
| |
20
| |-- accounts/ # Authentication pages
21
| | |-- login.html # Login page
22
| | |-- register.html # Register page
23
| |
24
| |-- home/ # UI Kit Pages
25
| |-- index.html # Index page
26
| |-- page-404.html # 404 page
27
| |-- *.html # All other pages
28
|
29
|-- ************************************************************************
Copied!

πŸ‘‰ Static Assets

The static assets used by the project (JS, CSS, images) are saved inside the apps/static/assets folder. This path can be customized with ease via ASSETS_ROOT variable saved in the .env file.
How it works
  • .env defines the ASSETS_ROOT variable
  • apps/config.py read the value of ASSETS_ROOT and defaults to /static/assets if not found:
1
# content of apps/config.py (truncated content)
2
​
3
ASSETS_ROOT = os.getenv('ASSETS_ROOT', '/static/assets')
Copied!
  • All pages and components use the config.ASSETS_ROOT variable. Here is a sample extracted from templates/layouts/base.html:
1
<head>
2
​
3
<!-- Source Code -->
4
<link rel="stylesheet" href="{{ config.ASSETS_ROOT }}/css/style.css">
5
​
6
<!-- RUNTIME -->
7
<link rel="stylesheet" href="/static/assets/css/style.css">
Copied!
At runtime, the href property is resolved to /static/assets/css/style.css based on the value saved in the .env file:
1
# No Slash at the end
2
ASSETS_ROOT=/static/assets
Copied!

✨ Customisation

πŸ‘‰ 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 - Install flask_mysqldb package
1
$ pip install flask_mysqldb
Copied!
Step 3 - Edit the .env to match your MySql DB credentials. Make sure DEBUG is set to False.
  • 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:
1
# .env sample
2
​
3
DEBUG=False # False enables the MySql Persistence
4
​
5
DB_ENGINE=mysql # Database Driver
6
DB_NAME=appseed_db # Database Name
7
DB_USERNAME=appseed_db_usr # Database User
8
DB_PASS=STRONG_PASS_HERE # Password
9
DB_HOST=localhost # Database HOST, default is localhost
10
DB_PORT=3306 # MySql port, default = 3306
Copied!
At this point, the app should use MySql for the persistence layer.

πŸ‘‰ Static Assets for production

As explained in the Static Assets section, the assets are managed via:
  • apps/static/assets - the folder where JS, CSS, and images files are saved
  • ASSETS_ROOT - environment variable, that defaults to /static/assets if not defined
In production, the contents of the apps/static/assets files should be copied to an external (public) directory and the ASSETS_ROOT environment variable updated accordingly.
For instance, if the static files are copied to https://cdn.your-server.com/volt-pro-assets, the .env file should be updated as below:
1
# No Slash at the end
2
ASSETS_ROOT=https://cdn.your-server.com/datta-able-assets
Copied!

πŸš€ Where to go from here