Skip to content

app-generator/flask-soft-ui-dashboard-pro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 

Repository files navigation

Premium Flask Dashboard project crafted on top of Soft Dashboard PRO, a pixel-perfect Bootstrap 5 design from Creative-Tim. Designed for those who like bold elements and beautiful websites, Soft UI Dashboard is ready to help you create stunning websites and webapps.


Features

  • Up-to-date dependencies
  • ✅ UI Kit: Soft UI Dashboard PRO (PRO Version) by Creative-Tim
  • 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)

Soft UI Dashboard PRO - Starter generated by AppSeed.


✨ Start the app in Docker

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

$ unzip flask-soft-ui-dashboard-pro.zip $ cd flask-soft-ui-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.


✨ How to use it

Download & unzip the code

$ unzip flask-soft-ui-dashboard-pro.zip $ cd flask-soft-ui-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)
  • FLASK_APP=run.py: mandatory (APP entry point)
  • 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 ...
  • CDN_DOMAIN: disabled by default
    • Used only when DEBUG=False (production mode)

Start the app

$ flask run

At 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

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)
  • FLASK_APP=run.py: mandatory (APP entry point)
  • 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 ...
  • CDN_DOMAIN: disabled by default
    • Used only when DEBUG=False (production mode)

Start the app

$ flask run

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


✨ Code-base structure

The project has a simple, intuitive structure presented bellow:

< PROJECT ROOT > | |-- apps/__init__.py |-- apps/ | |-- static/ | | |-- <css, JS, images> # CSS files, Javascripts files | | | |-- templates/ | | | |-- includes/ # Page chunks, components | | | | | |-- navigation.html # Top bar | | |-- scripts.html # JS scripts common to all pages | | |-- footer.html # The common footer | | | |-- layouts/ # App Layouts (the master pages) | | | | | |-- base.html # Used by common pages like index, UI | | | |-- pages/ # UI Kit Pages | |-- charts.html # Charts page | |-- widgets.html # Widgets page | |-- *.html # All other pages provded by the KIT | |-- requirements.txt | |-- run.py | |-- ************************************************************************


Soft UI Dashboard PRO Flask - Starter provided by AppSeed.

About

Soft UI Dashboard PRO - Flask Seed Project | AppSeed

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published