Volt Dashboard Flask
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๐ Volt Dashboard Flask -LIVE Demo๐ Volt Dashboard Flask -Documentation
๐ Built with App Generator, timestamp2022-06-23 18:20
โ Up-to-date dependenciesโ Database:SQLite, MySql- Silent fallback to
SQLite
- Silent fallback to
โ DB Tools: SQLAlchemy ORM,Flask-Migrateโ Authentication, Session Based,OAuthvia Githubโ Docker,Flask-Minify(page compression)๐ DeploymentCI/CDflow viaRender
โจ Quick start in Docker
๐ Step 1 - Download the code from the GH repository (usingGIT)
$ git clone https://github.com/app-generator/flask-volt-dashboard.git
$ cd flask-volt-dashboard
๐ Step 2 - Start the APP inDocker
$ docker-compose up --build Visit http://localhost:5085 in your browser. The app should be up & running.
โจ Video Presentation
flask-volt-dashboard-intro.mp4
โจ Create a new .env file using sample env.sample
The meaning of each variable can be found below:
DEBUG: ifTruethe app runs in develoment mode- For production value
Falseshould be used
- For production value
ASSETS_ROOT: used in assets management- default value:
/static/assets
- default value:
OAuthvia GithubGITHUB_ID=<GITHUB_ID_HERE>GITHUB_SECRET=<GITHUB_SECRET_HERE>
โจ Manual Build
Download the code
$ git clone https://github.com/app-generator/flask-volt-dashboard.git
$ cd flask-volt-dashboard๐ Set Up for Unix, MacOS
Install modules via
VENV
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txtSet Up Flask Environment
$ export FLASK_APP=run.py
$ export FLASK_ENV=developmentStart the app
$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS serverAt 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"Start the app
$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS serverAt this point, the app runs at http://127.0.0.1:5000/.
๐ 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
registrationpage and create a new user:http://127.0.0.1:5000/register
- Access the
sign inpage and authenticatehttp://127.0.0.1:5000/login
โจ 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
|
|-- ************************************************************************PRO Version
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โ Priorityon support
Volt Dashboard Flask - Open-source starter generated by App Generator.