app-generator/flask-soft-ui-dashboard

Soft UI Dashboard - Open-source Flask Dashboard | AppSeed

Soft UI Dashboard Flask

Open-source Flask Dashboard 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 - Product page
• 👉 Soft UI Dashboard Flask - LIVE Demo

Features

Have questions? Contact Support (Email & Discord) provided by AppSeed

Free Version	PRO Version	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	✅ 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 (Extra)
---------------------------------	---------------------------------	---------------------------------
✓ LIVE Demo	🚀 LIVE Demo PRO	🛒 Order: $999 (GUMROAD)

✅ Start in Docker

👉 Step 1 - Download the code from the GH repository (using GIT)

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

👉 Step 2 - Start the APP in Docker

$ 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_ID_HERE>
  • GITHUB_SECRET=<GITHUB_SECRET_HERE>

✅ Manual Build

👉 Download the code

$ 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

$ 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
// 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

$ # 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
// 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:

$ 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 - that uses PORT *5000 for the api
• Books API 2 - 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:

< 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
   |
   |-- ************************************************************************

✅ Flask Soft Dashboard 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 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 - product page
  • ✅ Enhanced UI - more pages and components
  • ✅ Priority on support

---

Soft UI Dashboard Flask - Open-source starter crafted by AppSeed.

flask-soft-ui-dashboard's Issues

Generating API

When running flask run gen_api keep getting Error: No such command 'gen_api'.

User List/My profile Missing side menu to show as selected

ISSUE
When clicking on the sidenav for my profile or user list menu items, the segment is not being sent. This causes the icon not to change to an active status (and show as selected).

REPLICATE

1. navigate to My profile - http://127.0.0.1:5000/profile or
2. Navigate to Users - http://127.0.0.1:5000/user_list
3. SideNav icons do not show as selected.

OpenAPI visual documentation is missing for verb/nouns

Hello,
I am looking at http://127.0.0.1/api where the visual documentation for the API is shown. Great that Open API has been implemented, but the documentation parameters are missing. This makes it a lot harder to work with it. Although I have to redesign the API nouns, it would help less experienced users to understand the API model and how to send the GET/POST JSON fields.

Also, the authorisation is missing from the schema. I can see the token on the user profile, but token authentication is not in the API doc (as seen on the Pet Store example -- AUTHORISE).

What I can see from SOFTUI:

What I wish to see (using openAPI PetStore Demo):

AUTHORISE

Error Pages (page-403.html) - Missing action/URL on GO TO HOME button

This is for FLASK SOFT UI DASHBOARD PRO 1.0.6

ISSUE:
The [GO TO HOME] button is missing the URL or action to go to the website's homepage.

Reproduce:

1. Open website http://127.0.0.1:5000/page-403.html
2. Click on the [GO TO HOME] Button

Missing Authentication verification for some Blueprint routes

Hello,
Some blueprint routes are missing the @login_required to prevent a user from manually placing a URL and accessing the page without proper authentication. Please confirm as I am getting error AttributeError: 'AnonymousUserMixin' object has no attribute 'role'

app\authentication\routes.py
@blueprint.route('/profile', methods=['GET', 'PUT'])
@blueprint.route('/user_list', methods=['GET'])
@blueprint.route('/update_status', methods=['PUT'])
@blueprint.route('/delete_user', methods=['DELETE'])
@blueprint.route('/confirm/')
@blueprint.route('/change_password', methods=['POST'])

Thank you.

Missing Blueprint for users-new-user.html

FOR FLASH SOFT UI DASHBOARD PRO 1.0.6:

ISSUE
An admin does not have a blueprint create new users. the page users-new-user.html exists but there is no blueprint to add the user.