Flask Dashboard Material
Open-source Flask Dashboard generated by AppSeed op top of a modern design. Designed for those who like bold elements and beautiful websites, Material Dashboard is ready to help you create stunning websites and webapps. Material Dashboard is built with over 70 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
π Flask Dashboard Material - product pageπ Flask Dashboard Material - LIVE deploymentπ Complete documentation -Learn how to use and update the product
π Built with App Generator, timestamp:2022-05-30 21:22
β Up-to-date dependenciesβ Database:sqliteβ DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)β Session-Based authentication (via flask_login), Forms validationβ Docker
β¨ Start the app in Docker
π Step 1 - Download the code from the GH repository (usingGIT)
$ git clone https://github.com/app-generator/flask-material-dashboard.git
$ cd flask-material-dashboard
π Step 2 - Start the APP inDocker
$ docker-compose up --build Visit http://localhost:5085 in your browser. The app should be up & running.
β¨ How to use it
Download the code
$ git clone https://github.com/app-generator/flask-material-dashboard.git
$ cd flask-material-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 runAt 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 runAt 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:
Material Dashboard is a premium Bootstrap 5 Design now available for download in Flask. Made of hundred of elements, designed blocks, and fully coded pages, Material Dashboard PRO is ready to help you create stunning websites and web apps.
π Material Dashboard PRO Flask - Product Pageπ Material Dashboard PRO Flask - LIVE Demo
Flask Dashboard Material - Free starter generated by App Generator.