Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/flask-v3-volt-dashboard
Flask v3 - Volt Dashboard (Free Sample) | AppSeed
https://github.com/app-generator/flask-v3-volt-dashboard
flask flask-bootstrap flask-bs5 flask-v3 flask-v3-sample flask-v3-template flask-volt flask3-sample flask3-template
Last synced: 10 days ago
JSON representation
Flask v3 - Volt Dashboard (Free Sample) | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/flask-v3-volt-dashboard
- Owner: app-generator
- License: other
- Created: 2023-10-02T08:11:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-02T08:38:05.000Z (about 1 year ago)
- Last Synced: 2024-10-11T04:44:10.610Z (about 1 month ago)
- Topics: flask, flask-bootstrap, flask-bs5, flask-v3, flask-v3-sample, flask-v3-template, flask-volt, flask3-sample, flask3-template
- Language: CSS
- Homepage: https://github.com/app-generator/flask-v3-volt-dashboard
- Size: 4.06 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Flask v3 `Volt Dashboard`
Open-source **Flask/Jinja Template** provided by `AppSeed` on top of **Volt Dashboard**, a modern `Bootstrap 5` dashboard design.
The project is a super simple Flask project WITHOUT database, ORM, or any other hard dependency - Design from **Themesberg**.
> Features
- ✅ `Up-to-date dependencies` using a **Flask v3.0.0** compatible stack
- ✅ Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
- ✅ **UI Kit**: Volt Dashboard by Themesberg
- ✅ `Docker`
- ✅ `CI/CD` via Render
## Start with `Docker`
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
```bash
$ git clone https://github.com/app-generator/flask-v3-volt-dashboard.git
$ cd flask-v3-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.
## Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/flask-v3-volt-dashboard.git
$ cd flask-v3-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
```
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
```
At this point, the app runs at `http://127.0.0.1:5000/`.
## Codebase Structure
The project has a simple, intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/__init__.py
|-- apps/
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/
| |
| |-- includes/ # Page chunks, components
| | |
| | |-- navigation.html # Top bar
| | |-- sidebar.html # Left sidebar
| | |-- scripts.html # JS scripts common to all pages
| | |-- footer.html # The common footer
| |
| |-- layouts/ # App Layouts (the master pages)
| | |
| | |-- base.html # Used by common pages like index, UI
| | |-- base-fullscreen.html # Used by auth pages (login, register)
| |
| index.html # The default page
| page-404.html # Error 404 page (page not found)
| page-500.html # Error 500 page (server error)
| *.html # All other pages provided by the UI Kit
|
|-- requirements.txt
|
|-- run.py
|
|-- ************************************************************************
```
## [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:
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
- 👉 [Flask Volt PRO](https://flask-volt-pro.appseed-srv1.com/) - LIVE deployment
---
Volt Dashboard - Open-source Flask v3 starter provided by **[AppSeed](https://appseed.us/)**.