Skip to content

Commit 273c298

Browse files
app-generatorapp-generator
committed
v1.0.17 - Update RM (minor)
1 parent bf00592 commit 273c298

File tree

3 files changed

+55
-204
lines changed

3 files changed

+55
-204
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ apps/static/assets/.temp
3333

3434
migrations
3535

36+
README_bk.md

‎CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Change Log
22

3+
## [1.0.17] 2025-04-01
4+
### Changes
5+
6+
- Update RM (minor)
7+
38
## [1.0.16] 2024-05-18
49
### Changes
510

‎README.md

Lines changed: 49 additions & 204 deletions
Original file line numberDiff line numberDiff line change
@@ -1,233 +1,78 @@
1-
# [Volt Dashboard Flask](https://appseed.us/product/volt-dashboard/flask/)
1+
# [Flask Volt Dashboard](https://app-generator.dev/product/volt-dashboard/flask/)
22

3-
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.
3+
Open-source **Flask Starter with Volt Dashboard Design**, an open-source iconic `Bootstrap` design.
4+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
45

5-
- 👉 [Volt Dashboard Flask](https://appseed.us/product/volt-dashboard/flask/) - `Product page`
6-
- 👉 [Volt Dashboard Flask](https://flask-volt-dashboard.appseed-srv1.com/) - `LIVE Demo`
6+
- 👉 [Flask Volt Dashboard](https://app-generator.dev/product/volt-dashboard/flask/) - `Product Page`
7+
- 👉 [Flask Volt Dashboard](https://flask-volt-dashboard.appseed-srv1.com/) - `LIVE Demo`
8+
- 👉 [Flask Volt Dashboard](https://app-generator.dev/docs/products/flask/volt-dashboard/index.html) - `Complete Information` and Support Links
9+
- [Getting Started with Flask](https://app-generator.dev/docs/technologies/flask/index.html) - a `comprehensive tutorial`
10+
- `Configuration`: Install Tailwind/Flowbite, Prepare Environment, Setting up the Database
11+
- `Start with Docker`
12+
- `Manual Build`
13+
- `Start the project`
14+
- `Deploy on Render`
715

816
<br />
917

1018
## Features
1119

12-
> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed**
13-
14-
| Free Version | [PRO Version](https://appseed.us/product/volt-dashboard-pro/flask/) | [Custom Development](https://appseed.us/custom-development/) |
15-
| --------------------------------------| --------------------------------------| --------------------------------------|
16-
| ✓ **Up-to-date dependencies** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
17-
| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1 Week** `Custom Development` |
18-
| ✓ DB: SQLite, MySql | ✅ `OAuth` for Github | ✅ **Team**: PM, Developer, Tester |
19-
| ✓ DB Tools: ORM, Flask-Migrate | ✅ `Extended User Model` | ✅ Weekly Sprints |
20-
| ✓ Session-Based authentication | ✅ `Users Roles` | ✅ Technical SPECS |
21-
| ✓ `Docker` | ✅ `Private REPO Access` | ✅ Documentation |
22-
| ✓ `CI/CD` Flow via Render | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | ✅ **30 days Delivery Warranty** |
23-
| ✓ `Free Support` | - | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** |
24-
| --------------------------------- | --------------------------------- | --------------------------------- |
25-
| ✓ [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/)** |
20+
- Simple, Easy-to-Extend codebase, [Blueprint Pattern](https://app-generator.dev/blog/flask-blueprints-a-developers-guide/)
21+
- Up-to-date Dependencies
22+
- [Volt Dashboard](https://app-generator.dev/docs/templates/bootstrap/volt-dashboard.html) Full Integration
23+
- [Bootstrap](https://app-generator.dev/docs/templates/bootstrap/index.html) 5 Styling
24+
- Auth: Session Based, GitHub, Google
25+
- Celery Beat
26+
- DB Persistence: SQLite (default),
27+
- Easy switch to MySql/MariaDB, PgSql
28+
- Dynamic DataTables - manage data without coding
29+
- CI/CD integration for [Render](https://app-generator.dev/docs/deployment/render/index.html)
30+
- Deployment: Docker, Flask-Minify
2631

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

29-
## ✅ Environment
30-
31-
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:
32-
33-
- [Python3](https://www.python.org) - the programming language used to code the app
34-
- [GIT](https://git-scm.com) - used to clone the source code from the Github repository
35-
- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
36-
- (Optional) `Docker` - a popular virtualization software
37-
38-
## ✅ Start in `Docker`
39-
40-
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
41-
42-
```bash
43-
$ git clone https://github.com/app-generator/flask-volt-dashboard.git
44-
$ cd flask-volt-dashboard
45-
```
46-
47-
<br />
48-
49-
> 👉 **Step 2** - Start the APP in `Docker`
50-
51-
```bash
52-
$ docker-compose up --build
53-
```
54-
55-
Visit `http://localhost:5085` in your browser. The app should be up & running.
56-
57-
58-
## ✅ Create `.env` file
59-
60-
The meaning of each variable can be found below:
61-
62-
- `DEBUG`: if `True` the app runs in develoment mode
63-
- For production value `False` should be used
64-
- `ASSETS_ROOT`: used in assets management
65-
- default value: `/static/assets`
66-
- `OAuth` via Github
67-
- `GITHUB_ID`=<GITHUB_ID_HERE>
68-
- `GITHUB_SECRET`=<GITHUB_SECRET_HERE>
69-
70-
71-
## ✅ Manual Build
72-
73-
> Download the code
74-
75-
```bash
76-
$ git clone https://github.com/app-generator/flask-volt-dashboard.git
77-
$ cd flask-volt-dashboard
78-
```
79-
80-
<br />
81-
82-
### 👉 Set Up for `Unix`, `MacOS`
83-
84-
> Install modules via `VENV`
85-
86-
```bash
87-
$ virtualenv env
88-
$ source env/bin/activate
89-
$ pip3 install -r requirements.txt
90-
```
91-
9234
<br />
9335

94-
> Set Up Flask Environment
36+
## Deploy LIVE
9537

96-
```bash
97-
$ export FLASK_APP=run.py
98-
$ export FLASK_ENV=development
99-
```
38+
> One-click deploy (requires already having an account).
10039
101-
<br />
102-
103-
> Start the app
104-
105-
```bash
106-
$ flask run
107-
// OR
108-
$ flask run --cert=adhoc # For HTTPS server
109-
```
110-
111-
At this point, the app runs at `http://127.0.0.1:5000/`.
112-
113-
<br />
114-
115-
### 👉 Set Up for `Windows`
116-
117-
> Install modules via `VENV` (windows)
118-
119-
```
120-
$ virtualenv env
121-
$ .\env\Scripts\activate
122-
$ pip3 install -r requirements.txt
123-
```
124-
125-
<br />
126-
127-
> Set Up Flask Environment
40+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
12841

129-
```bash
130-
$ # CMD
131-
$ set FLASK_APP=run.py
132-
$ set FLASK_ENV=development
133-
$
134-
$ # Powershell
135-
$ $env:FLASK_APP = ".\run.py"
136-
$ $env:FLASK_ENV = "development"
137-
```
42+
<br />
13843

139-
<br />
140-
141-
> Start the app
142-
143-
```bash
144-
$ flask run
145-
// OR
146-
$ flask run --cert=adhoc # For HTTPS server
147-
```
148-
149-
At this point, the app runs at `http://127.0.0.1:5000/`.
150-
151-
<br />
44+
## [Volt Dashboard PRO Version](https://app-generator.dev/product/volt-dashboard-pro/flask/)
15245

153-
### 👉 Create Users
46+
> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://flask-volt-dashboard-enh.appseed-srv1.com/).
15447
155-
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
48+
- **Simple, Easy-to-Extend** Codebase
49+
- **Volt Dashboard** Design - PRO Version
50+
- Bootstrap 4 CSS
51+
- **Deployment-Ready** for Render
15652

157-
- Start the app via `flask run`
158-
- Access the `registration` page and create a new user:
159-
- `http://127.0.0.1:5000/register`
160-
- Access the `sign in` page and authenticate
161-
- `http://127.0.0.1:5000/login`
162-
163-
<br />
164-
165-
## ✅ Codebase
166-
167-
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
168-
169-
```bash
170-
< PROJECT ROOT >
171-
|
172-
|-- apps/
173-
| |
174-
| |-- home/ # A simple app that serve HTML files
175-
| | |-- routes.py # Define app routes
176-
| |
177-
| |-- authentication/ # Handles auth routes (login and register)
178-
| | |-- routes.py # Define authentication routes
179-
| | |-- models.py # Defines models
180-
| | |-- forms.py # Define auth forms (login and register)
181-
| |
182-
| |-- static/
183-
| | |-- <css, JS, images> # CSS files, Javascripts files
184-
| |
185-
| |-- templates/ # Templates used to render pages
186-
| | |-- includes/ # HTML chunks and components
187-
| | | |-- navigation.html # Top menu component
188-
| | | |-- sidebar.html # Sidebar component
189-
| | | |-- footer.html # App Footer
190-
| | | |-- scripts.html # Scripts common to all pages
191-
| | |
192-
| | |-- layouts/ # Master pages
193-
| | | |-- base-fullscreen.html # Used by Authentication pages
194-
| | | |-- base.html # Used by common pages
195-
| | |
196-
| | |-- accounts/ # Authentication pages
197-
| | | |-- login.html # Login page
198-
| | | |-- register.html # Register page
199-
| | |
200-
| | |-- home/ # UI Kit Pages
201-
| | |-- index.html # Index page
202-
| | |-- 404-page.html # 404 page
203-
| | |-- *.html # All other pages
204-
| |
205-
| config.py # Set up the app
206-
| __init__.py # Initialize the app
207-
|
208-
|-- requirements.txt # App Dependencies
209-
|
210-
|-- .env # Inject Configuration via Environment
211-
|-- run.py # Start the app - WSGI gateway
212-
|
213-
|-- ************************************************************************
214-
```
53+
![Volt Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172672843-8c40a801-3438-4e9c-86db-38a34191fbdf.png)
21554

21655
<br />
21756

218-
## ✅ [PRO Version](https://appseed.us/product/volt-dashboard-pro/flask/)
57+
## `Customize` with [Flask Generator](https://app-generator.dev/tools/flask-generator/)
21958

220-
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
59+
- Access the [Flask Generator](https://app-generator.dev/tools/flask-generator/)
60+
- Select the preferred design
61+
- (Optional) Design Database: edit models and fields
62+
- (Optional) Edit the fields for the extended user model
63+
- (Optional) Enable OAuth for GitHub
64+
- (Optional) Add Celery (async tasks)
65+
- (Optional) Enable Dynamic Tables Module
66+
- Docker Scripts
67+
- Render CI/Cd Scripts
22168

222-
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.
69+
**The generated Flask project is available as a ZIP Archive and also uploaded to GitHub.**
22370

224-
- 👉 [Flask Volt PRO](https://appseed.us/product/volt-dashboard-pro/flask/) - product page
225-
- ✅ `Enhanced UI` - more pages and components
226-
- ✅ `Priority` on support
71+
![Flask Generator - Flask App Generator - User Interface for choosing the Design](https://github.com/user-attachments/assets/fbf73fc0-e9a1-4f01-86a8-aa8be55413b5)
22772

228-
![Volt Dashboard PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/172672843-8c40a801-3438-4e9c-86db-38a34191fbdf.png)
73+
![Flask App Generator - User Interface for Edit the Extended User Model](https://github.com/user-attachments/assets/138b9816-4f2e-454f-84f2-7409969b8548)
22974

230-
<br />
75+
<br />
23176

23277
---
233-
[Volt Dashboard Flask](https://appseed.us/product/volt-dashboard/flask/) - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.
78+
[Flask Volt Dashboard](https://app-generator.dev/product/volt-dashboard/flask/) - Open-Source **Flask** Starter provided by [App Generator](https://app-generator.dev)

0 commit comments

Comments
 (0)