Open-Source Flask Dashboard generated by the AppSeed
platform with basic modules, database, authentication and deployment scripts on top of Volt Dashboard (free version). Volt Dashboard is a free and open source Bootstrap 5 dashboard template featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS. There are more than 100 free Bootstrap 5 components included some of them being buttons, alerts, modals, datepickers and so on.
- ๐ Volt Dashboard Flask - product page
- ๐ Complete documentation -
Learn how to use and update the product
- ๐ Free support for registered users (Email &
Discord
)
Built with App Generator, timestamp
2023-02-23 03:14
- โ
Up-to-date dependencies
- โ
Database
:SQLite
, MySql- Silent fallback to
SQLite
- Silent fallback to
- โ
DB Tools
: SQLAlchemy ORM, Flask-Migrate (schema migrations) - โ Session-Based authentication (via flask_login), Forms validation
- โ
Flask-Minify
(page compression)
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
databaseCreate a new user
and assign full privilegies (read/write)
Step 2 - Edit the
.env
to match your MySql DB credentials. Make sureDB_ENGINE
is set tomysql
.
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
Download the code
$ # Get the code
$ git clone https://github.com/appseed-projects/72aa9667-f404-4c60-b00c-19248c546cc7.git
$ cd 72aa9667-f404-4c60-b00c-19248c546cc7
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
Start the app
$ flask run
At this point, the app runs at http://127.0.0.1:5000/
.
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"
Start the app
$ flask run
At this point, the app runs at http://127.0.0.1:5000/
.
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 authenticatehttp://127.0.0.1:5000/login
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
|
|-- ************************************************************************
The set up
- Create a FREE account on Heroku platform
- Install the Heroku CLI that match your OS: Mac, Unix or Windows
- Open a terminal window and authenticate via
heroku login
command - Clone the sources and push the project for LIVE deployment
Step 1 - Download the code from the GH repository (using
GIT
)
$ # Get the code
$ git clone https://github.com/appseed-projects/<YOUR_BUILD_ID>.git
$ cd <YOUR_BUILD_ID>
Step 2 - Connect to
HEROKU
using the console
$ # This will open a browser window - click the login button (in browser)
$ heroku login
Step 3 - Create the
HEROKU
project
$ heroku create
Step 4 - Push Sources to
HEROKU
$ git push heroku HEAD:master
Step 5 - Srt up the APP Environemnt in
HEROKU
(.env
file is ignored by the platform)
DEBUG
=TrueFLASK_APP
=run.pyFLASK_ENV
=developmentASSETS_ROOT
=/static/assets
Step 6 - Visit the app in the browser
$ $ heroku open
At this point, the APP should be up & running.
Step 7 (Optional) - Visualize
HEROKU
logs
$ heroku logs --tail
For more components, pages and priority on support, feel free to take a look at this amazing starter:
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.
- ๐ Flask Volt PRO - product page
- โ
Enhanced UI
- more pages and components - โ
Priority
on support
- โ
Volt Dashboard Flask - Open-source starter generated by App Generator.