Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/flask-soft-ui-dashboard
Soft UI Dashboard - Open-source Flask Dashboard | AppSeed
https://github.com/app-generator/flask-soft-ui-dashboard
appseed flask-application flask-bootstrap5 flask-bs5 flask-dashboard flask-sample-application flask-soft-template flask-soft-ui flask-template soft-dashboard soft-dashboard-flask soft-dashboard-starter soft-design soft-ui soft-ui-dashboard soft-ui-flask
Last synced: 14 days ago
JSON representation
Soft UI Dashboard - Open-source Flask Dashboard | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-soft-ui-dashboard
- Owner: app-generator
- License: other
- Created: 2021-05-12T04:35:37.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T08:43:17.000Z (4 months ago)
- Last Synced: 2024-10-11T04:43:39.972Z (about 1 month ago)
- Topics: appseed, flask-application, flask-bootstrap5, flask-bs5, flask-dashboard, flask-sample-application, flask-soft-template, flask-soft-ui, flask-template, soft-dashboard, soft-dashboard-flask, soft-dashboard-starter, soft-design, soft-ui, soft-ui-dashboard, soft-ui-flask
- Language: SCSS
- Homepage: https://appseed.us/product/soft-ui-dashboard/flask/
- Size: 31 MB
- Stars: 177
- Watchers: 7
- Forks: 103
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Soft UI Dashboard Flask](https://appseed.us/product/soft-ui-dashboard/flask/)
Open-source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by `AppSeed` on top of a modern design. Designed for those who like bold elements and beautiful websites, **Soft UI Dashboard** is ready to help you create stunning websites and web apps - Design from `Creative-Tim`.
- 👉 [Soft UI Dashboard Flask](https://appseed.us/product/soft-ui-dashboard/flask/) - Product page
- 👉 [Soft UI Dashboard Flask](https://flask-soft-ui-dashboard.appseed-srv1.com/) - LIVE Demo
## Features
> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed**
| Free Version | [PRO Version](https://appseed.us/product/soft-ui-dashboard-pro/flask/) | [Custom Development](https://appseed.us/custom-development/) |
| --------------------------------------| --------------------------------------| --------------------------------------|
| ✓ **Up-to-date dependencies** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1 Week** `Custom Development` |
| ✓ DB: SQLite, MySql | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | ✅ **Team**: PM, Developer, Tester |
| ✓ DB Tools: ORM, Flask-Migrate | ✅ `Private REPO Access` | ✅ Weekly Sprints |
| ✓ Session-Based authentication | - | ✅ Technical SPECS |
| ✓ `Docker` | - | ✅ Documentation |
| ✓ `CI/CD` Flow via Render | - | ✅ **30 days Delivery Warranty** |
| ✓ `Free Support` | - | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** |
| --------------------------------- | --------------------------------- | --------------------------------- |
| ✓ [LIVE Demo](https://flask-soft-ui-dashboard.appseed-srv1.com/) | 🚀 [LIVE Demo](https://flask-soft-dashboard-enh.appseed-srv1.com/) `PRO` | **[Get in Touch ➡️](https://appseed.us/custom-development/)** |
## ✅ Start in `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/flask-soft-ui-dashboard.git
$ cd flask-soft-ui-dashboard
```
> 👉 **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.
## ✅ Create `.env` file
The meaning of each variable can be found below:
- `DEBUG`: if `True` the app runs in development mode
- For production value `False` should be used
- `ASSETS_ROOT`: used in assets management
- default value: `/static/assets`
- `OAuth` via Github
- `GITHUB_ID`=
- `GITHUB_SECRET`=
## ✅ Manual Build
> 👉 Download the code
```bash
$ git clone https://github.com/app-generator/flask-soft-ui-dashboard.git
$ cd flask-soft-ui-dashboard
```
### 👉 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_ENV=development
```
> Start the app
```bash
$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS server
```
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_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"
```
> Start the app
```bash
$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS server
```
At this point, the app runs at `http://127.0.0.1:5000/`.
## ✅ API Generator
This module helps to generate secure APIs using `Flask-restX` via a simple workflow:
- Edit/add your model in `apps/models.py`
- Migrate the database:
```bash
$ flask db init # This should be executed only once
$ flask db migrate # Generates the SQL
$ flask db upgrade # Apply changes
```
- Update Configuration:
- `apps/config .py`, section `API_GENERATOR`
- Generate the API code:
- `$ flask gen_api` # the new code is saved in `apps/api`
- Access the API in the browser:
- `/api/MODEL_NAME/`
The API is secured using the JWT tocken provided by `/login/jwt/` request (username & password should be provided).
- GET requests are public (GET all, get Item)
- Mutating requests are protected by token generated based on the user credentials (`username`, `pass`).
> Two POSTMAN Collections are provided in the `media` directory:
- [Books API](./media/api-books.postman_collection) - that uses PORT **5000* for the api
- [Books API 2](./media/api-books-docker.postman_collection) - that uses PORT **5085* for the api (default port in Docker)
In case both ports are unusable in your environment, feel free to edit the files before POSTMAN import.
### 👉 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`
## ✅ Codebase
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
|
|-- ************************************************************************
```
## ✅ [Flask Soft Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/flask/) `PRO`
> For more components, pages and priority on support, feel free to take a look at this starter:
Soft UI Dashboard is a premium [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design now available for download in Flask. Made of hundred of elements, designed blocks, and fully coded pages, Soft UI Dashboard PRO is ready to help you create stunning websites and web apps.
- 👉 [Soft UI Dashboard PRO Flask](https://appseed.us/product/soft-ui-dashboard-pro/flask/) - `product page`
- ✅ `Enhanced UI` - more pages and components
- ✅ `Priority` on support
---
[Soft UI Dashboard Flask](https://appseed.us/product/soft-ui-dashboard/flask/) - Open-source starter crafted by **[AppSeed](https://appseed.us/)**.