https://github.com/app-generator/flask-soft-ui-design
Soft UI Design System - Flask Starter | AppSeed
https://github.com/app-generator/flask-soft-ui-design
flask-apps flask-template jinja soft-ui-design
Last synced: about 2 months ago
JSON representation
Soft UI Design System - Flask Starter | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-soft-ui-design
- Owner: app-generator
- License: other
- Created: 2021-03-09T15:58:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T11:59:19.000Z (12 months ago)
- Last Synced: 2025-08-12T19:49:06.045Z (2 months ago)
- Topics: flask-apps, flask-template, jinja, soft-ui-design
- Language: HTML
- Homepage: https://appseed.us/product/soft-ui-design/flask/
- Size: 20.7 MB
- Stars: 54
- Watchers: 3
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Soft UI Design Flask](https://appseed.us/product/soft-ui-design/flask/)
`Open-Source` **[Flask App](https://appseed.us/apps/flask/)** crafted on top of a modern design. Designed for those who like bold elements and beautiful websites, **Soft UI Design** is ready to help you create stunning websites and web apps. **Soft UI Design** 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.
- 👉 [Soft UI Design Flask](https://appseed.us/product/soft-ui-design/flask/) - Product page
- 👉 [Soft UI Design Flask](https://flask-soft-ui-free.appseed-srv1.com/) - LIVE Demo
## Deploy on `Render` (free plan)
[](https://render.com/deploy)
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
$ cd flask-soft-ui-design
```
> 👉 **Step 2** - Start the APP in `Docker`
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
$ cd flask-soft-ui-design
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_DEBUG=True
```
> Start the app
```bash
$ 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
```bash
$ # CMD
$ set FLASK_APP=run.py
$ set FLASK_DEBUG=True
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_DEBUG = "True"
```
> Start the app
```bash
$ flask run
```
At 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 `registration` page and create a new user:
- `http://127.0.0.1:5000/register`
- Access the `sign in` page and authenticate
- `http://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:
```bash
< 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 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:
Soft UI Design is a premium Bootstrap 5 Design now available for download in Flask. Made of hundred of elements, designed blocks, and fully coded pages, Soft UI Design PRO is ready to help you create stunning websites and web apps.
- 👉 [Soft UI Design PRO Flask](https://appseed.us/product/soft-ui-design-pro/flask/) - Product Page
- 👉 [Soft UI Design PRO Flask](https://flask-soft-ui-design-pro.appseed-srv1.com/) - LIVE Demo
---
[Soft UI Design Flask](https://appseed.us/product/soft-ui-design/flask/) - Open-source Flask Starter provided by **[App Generator](https://app-generator.dev/)**.