Sm0ke

Posted on May 12, 2021 • Edited on Oct 25, 2023 • Originally published at blog.appseed.us

Soft UI Dashboard - Open-source Flask Starter

#webdev #flask #python #opensource

Hello Coders,

This article presents an open-source Flask starter that might help beginners to start faster a new project and reuse a codebase already enhanced with database, authentication and deployment scripts on top of a modern UI Kit: Soft UI Dashboard. The product can be downloaded from Github and used for hobby and commercial products.

Thanks for reading! - Content provided by App Generator.

✨ Flask Soft UI Dashboard - product page
✨ Flask Soft UI Dashboard - LIVE Demo

Soft UI Dashboard is an open-source Bootstrap 5 template released under the MIT License (free for commercial use) by Creative-Tim agency. The product is built with over 70 frontend individual elements, like buttons, inputs, navbars, navtabs, cards or alerts, giving you the freedom of choosing and combining. All components can take variations in color, that you can easily modify using SASS files and classes.

Example Pages - If you want to get inspiration or just show something directly to your clients, you can jump-start your development with our pre-built example pages. You will be able to quickly set up the basic structure for your web project.

Authentication Pages: Login and Register
Utility pages: User Profile, Billing page
RTL Support: YES.

✨ How to compile the code

To compile this Flask starter in a local environment a minimal programming kit must be already installed and all tools accessible in the terminal.

Nodejs - version 10.x or above
Yarn - a smart package manager for Node
GIT - versioning command-line tool
Gulp - toolkit automation
Python3 - the interpreter

Some of the above tools are optional but recommended. Once we have the environment ready, we can move on and compile the project using the build instructions provided in the README file.

✨ Step #1 - Clone/download sources

$ git clone https://github.com/app-generator/flask-soft-ui-dashboard.git
$ cd flask-soft-ui-dashboard

✨ Step #2 - Install dependencies

$ virtualenv env
$ source env/bin/activate
$
$ # Install modules - SQLite Database
$ pip3 install -r requirements.txt

✨ Step #3 - Set up environment variables (for different systems)

$ export FLASK_APP=run.py         # Linux, MacOS
$ export FLASK_ENV=development    # Linux, MacOS
$
$ set FLASK_APP=run.py            # Windows CMD
$ set FLASK_ENV=development       # Windows CMD
$
$ $env:FLASK_APP = ".\run.py"     # Windows Powershell
$ $env:FLASK_ENV = "development"  # Windows Powershell

✨ Step #4 - Start the application via Flask embedded server

$ flask run
$
$ # Access the dashboard in browser: http://127.0.0.1:5000/

By default, the app will route guest users to the login page to authenticate. To pass the login please create a new user first.

Thanks for reading! For more resources, feel free to access:

👉 More Flask Dashboards crafted in Django, Flask, and React
👉 More Flask Apps - free & PAID

Top comments (7)

Ronald van Weerd • Oct 24 '23

For anyone using a Windows system and struggling with "Step #3 - Set up environment variables", the Windows equivalent of the Unix export is set.

So in Windows, use:

$ # Set the FLASK_APP environment variable
$ set FLASK_APP=run.py
$
$ # Set up the DEBUG environment
$ set FLASK_ENV=development

Sm0ke • Oct 25 '23

Hello Ronald & Ty for your correction.

The section has been updated with the complete information for all OSs:

$ export FLASK_APP=run.py         # Linux, MacOS
$ export FLASK_ENV=development    # Linux, MacOS
$
$ set FLASK_APP=run.py            # Windows CMD
$ set FLASK_ENV=development       # Windows CMD
$
$ $env:FLASK_APP = ".\run.py"     # Windows Powershell
$ $env:FLASK_ENV = "development"  # Windows Powershell