Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/app-generator/flask-volt-dashboard

Flask Bootstrap 5 - Volt Dashboard | AppSeed
https://github.com/app-generator/flask-volt-dashboard

flask-bs5 flask-volt flask-volt-bs5 flask-volt-dashboard volt-app volt-bs5-flask volt-dashboard volt-dashboard-flask volt-dashboard-fullstack volt-flask volt-webapp

Last synced: 3 days ago
JSON representation

Flask Bootstrap 5 - Volt Dashboard | AppSeed

Host: GitHub
URL: https://github.com/app-generator/flask-volt-dashboard
Owner: app-generator
License: other
Created: 2020-10-01T08:25:54.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-07-22T08:43:51.000Z (4 months ago)
Last Synced: 2024-10-11T04:43:39.541Z (25 days ago)
Topics: flask-bs5, flask-volt, flask-volt-bs5, flask-volt-dashboard, volt-app, volt-bs5-flask, volt-dashboard, volt-dashboard-flask, volt-dashboard-fullstack, volt-flask, volt-webapp
Language: CSS
Homepage: https://appseed.us/product/volt-dashboard/flask/
Size: 14.7 MB
Stars: 232
Watchers: 6
Forks: 105
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

jimsghstars - app-generator/flask-volt-dashboard - Flask Bootstrap 5 - Volt Dashboard | AppSeed (CSS)

README

        # [Volt Dashboard Flask](https://appseed.us/product/volt-dashboard/flask/)

Open-Source **[Flask Dashboard](https://appseed.us/admin-dashboards/flask/)** generated by the `AppSeed` platform with basic modules, database, authentication, and deployment scripts on top of **Volt Dashboard** (free version). Volt Dashboard is a free and open-source **Bootstrap 5** dashboard template featuring over 100 components, 11 example pages, and 3 plugins with Vanilla JS. There are more than 100 free Bootstrap 5 components included some of them being buttons, alerts, modals, date pickers, and so on.

- 👉 [Volt Dashboard Flask](https://appseed.us/product/volt-dashboard/flask/) - `Product page`

- 👉 [Volt Dashboard Flask](https://flask-volt-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/volt-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                       | ✅ `OAuth` for Github                                                | ✅ **Team**: PM, Developer, Tester     |

| ✓ DB Tools: ORM, Flask-Migrate            | ✅ `Extended User Model`                                             | ✅ Weekly Sprints                      |

| ✓ Session-Based authentication            | ✅ `Users Roles`                                                     | ✅ Technical SPECS                     |

| ✓ `Docker`                                | ✅ `Private REPO Access`                                             | ✅ Documentation                       |

| ✓ `CI/CD` Flow via Render                 | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/)  | ✅ **30 days Delivery Warranty**        |

| ✓ `Free Support`                          | -                                                                     | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)**    |

| ---------------------------------         | ---------------------------------                                     | ---------------------------------  |

| ✓ [LIVE Demo](https://flask-volt-dashboard.appseed-srv1.com/)  | 🚀 [LIVE Demo](https://flask-volt-dashboard-enh.appseed-srv1.com/) `PRO` | **[Get in Touch ➡️](https://appseed.us/custom-development/)** |  

![Volt Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168843604-b026fd94-5969-4be7-81ac-5887cf0958e5.png)

## ✅ Environment

To use the starter, [Python3](https://www.python.org) 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](https://www.python.org) - the programming language used to code the app

- [GIT](https://git-scm.com) - 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 from the GH repository (using `GIT`) 

```bash

$ git clone https://github.com/app-generator/flask-volt-dashboard.git

$ cd flask-volt-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 develoment 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-volt-dashboard.git

$ cd flask-volt-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/`. 




### 👉 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

   |

   |-- ************************************************************************

```




## ✅ [PRO Version](https://appseed.us/product/volt-dashboard-pro/flask/)

> For more components, pages and priority on support, feel free to take a look at this amazing starter:

Volt Pro is a premium Bootstrap 5 Admin Dashboard featuring over 800 components, 20 example pages and 10 fully customized plugin written in Vanilla Javascript. 

- 👉 [Flask Volt PRO](https://appseed.us/product/volt-dashboard-pro/flask/) - product page

  - ✅ `Enhanced UI` - more pages and components

  - ✅ `Priority` on support

![Volt Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172672843-8c40a801-3438-4e9c-86db-38a34191fbdf.png)




---

[Volt Dashboard Flask](https://appseed.us/product/volt-dashboard/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.