Flask Soft Design PRO
Premium Flask Starter coded on top Soft UI Design (Premium Version).
Flask project crafted on top of Material Kit BS5, a premium design from Creative-Tim. The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
- 👉 Soft UI Design PRO Flask - Product page
- 👉 Soft UI Design PRO Flask - LIVE Demo
2022-09-13
✅ Features
- UI KIT: Soft Design PRO designed by
Creative-Tim
Database
:SQLite
, MySql- Silent fallback to
SQLite
- Silent fallback to
DB Tools
: SQLAlchemy ORM, Flask-Migrate (schema migrations)- Session-Based authentication (via flask_login), Forms validation
- Docker,
Flask-Minify
(page compression) Deployment
CI/CD
flow viaRender
✅ Environment
To use the starter, Python3 should be installed properly in the workstation.
If you are not sure if Python is installed, please open a terminal and type python --version
. Here is the full list with dependencies and tools required to build the app:
- Python3 - the programming language used to code the app
- GIT - used to clone the source code from the Github repository
- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
- (Optional)
Docker
- a popular virtualization software
✅ Start in Docker
👉 Step 1 - Download the code and unzip the sources (requires a
purchase
).
$ unzip flask-soft-design-pro.zip
$ cd flask-soft-design-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
Download the code and unzip the sources (requires a
purchase
).
$ unzip flask-soft-design-pro.zip
$ cd flask-soft-design-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
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
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
$ # 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
At this point, the app runs at http://127.0.0.1:5000/
.
✅ Manage App Users
By default, the starter is not provided with users.
👉 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
registration
page and create a new user:http://127.0.0.1:5000/register
- Access the
sign in
page and authenticatehttp://127.0.0.1:5000/login
✅ Codebase structure
The project is coded using a simple and intuitive structure presented below:
< 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
|
|-- ************************************************************************
✅ Resources
- 👉 Access AppSeed for more starters and support
- 👉 Deploy Projects on Aws, Azure and DO via DeployPRO
- 👉 Create landing pages with Simpllo, an open-source site builder
- 👉 Build apps with Django App Generator (free service)