/flask-material-dashboard-pro

Flask Dashboard - Material Design PRO Design | AppSeed

OtherNOASSERTION

Flask Material PRO BS4

Flask Dashboard starter styled with Material Design PRO, a premium Bootstrap 4 KIT from Creative-Tim. The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.


Features

  • ✅ Up-to-date dependencies
  • ✅ Database: SQLite, MySql
    • Silent fallback to SQLite
  • ✅ DB Tools: SQLAlchemy ORM, Flask-Migrate
  • ✅ Authentication, Session Based
  • ✅ Docker, Page Compression via Flask-Minify
  • 🚀 Deployment
    • CI/CD flow via Render
    • CDN Support (optional)

Material PRO BS4


Start in Docker

👉 Step 1 - Download & Unzip the code (requires a purchase from the official product page)

$ unzip flask-material-dashboard-pro.zip
$ cd flask-material-dashboard-pro

👉 Step 2 - Start the APP in Docker

$ docker-compose up --build

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


Manual Build

👉 Step 1 - Download & Unzip the code (requires a purchase from the official product page)

$ unzip flask-material-dashboard-pro.zip
$ cd flask-material-dashboard-pro

👉 Set Up for Unix, MacOS

Install modules via VENV

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

Set Up Flask Environment

Edit .env using env.sample or simply export the variables in the environment. Here are the expected values:

  • DEBUG: controls the Development, Production mode
    • Default False (production)
  • SECRET_KEY: optional, random value used if not provided
  • DB credentials
    • Note: if NOT provided, or wrong values, SQLite is used
    • DB_ENGINE, DB_HOST, DB_NAME ...

Start the app

$ flask run

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


✨ 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                     # Development modules - SQLite storage
   |
   |-- Dockerfile                           # Deployment
   |-- docker-compose.yml                   # Deployment
   |-- gunicorn-cfg.py                      # Deployment   
   |-- nginx                                # Deployment
   |    |-- appseed-app.conf                # Deployment 
   |
   |-- .env                                 # Inject Configuration via Environment
   |-- run.py                               # Start the app - WSGI gateway
   |
   |-- ************************************************************************

Flask Material PRO BS4 - Provided by AppSeed.