Skip to content

Commit 0b72cb5

Browse files
app-generatorapp-generator
committed
Initial Version - STABLE
1 parent f455255 commit 0b72cb5

File tree

424 files changed

+164658
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

424 files changed

+164658
-1
lines changed

‎.gitignore‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
5+
# tests and coverage
6+
*.pytest_cache
7+
.coverage
8+
9+
# database & logs
10+
*.db
11+
*.sqlite3
12+
*.log
13+
14+
# venv
15+
env
16+
venv
17+
18+
# other
19+
.DS_Store
20+
21+
# sphinx docs
22+
_build
23+
_static
24+
_templates
25+
26+
# javascript
27+
package-lock.json
28+
.vscode/symbols.json
29+
30+
apps/static/assets/node_modules
31+
apps/static/assets/yarn.lock
32+
apps/static/assets/.temp
33+
34+
35+
migrations
36+

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
3+
4+
## [1.0.0] 2023-10-02
5+
### Changes
6+
7+
- Initial Version

‎Dockerfile‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
FROM python:3.9
2+
3+
# set environment variables
4+
ENV PYTHONDONTWRITEBYTECODE 1
5+
ENV PYTHONUNBUFFERED 1
6+
7+
COPY requirements.txt .
8+
9+
# install python dependencies
10+
RUN pip install --upgrade pip
11+
RUN pip install --no-cache-dir -r requirements.txt
12+
13+
COPY . .
14+
15+
# gunicorn
16+
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "run:app"]

‎LICENSE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
<br />
10+
11+
| Item | - |
12+
| ---------------------------------- | --- |
13+
| License Type | MIT |
14+
| Use for print | **YES** |
15+
| Create single personal website/app | **YES** |
16+
| Create single website/app for client | **YES** |
17+
| Create multiple website/apps for clients | **YES** |
18+
| Create multiple SaaS applications | **YES** |
19+
| End-product paying users | **YES** |
20+
| Product sale | **YES** |
21+
| Remove footer credits | **YES** |
22+
| --- | --- |
23+
| Remove copyright mentions from source code | NO |
24+
| Production deployment assistance | NO |
25+
| Create HTML/CSS template for sale | NO |
26+
| Create Theme/Template for CMS for sale | NO |
27+
| Separate sale of our UI Elements | NO |
28+
29+
<br />
30+
31+
---
32+
For more information regarding licensing, please contact the AppSeed Service < *[email protected]* >

‎README.md‎

Lines changed: 172 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,172 @@
1-
# flask-v3-volt-dashboard
1+
# Flask v3 `Volt Dashboard`
2+
3+
Open-source **Flask/Jinja Template** provided by `AppSeed` on top of **Volt Dashboard**, a modern `Bootstrap 5` dashboard design.
4+
5+
The project is a super simple Flask project WITHOUT database, ORM, or any other hard dependency - Design from **[Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200)**.
6+
7+
> Features
8+
9+
- ✅ `Up-to-date dependencies` using a **Flask v3.0.0** compatible stack
10+
- ✅ Render Engine: Flask / [Jinja2](https://jinja.palletsprojects.com/)
11+
- ✅ **UI Kit**: [Soft Dashboard BS5](https://www.creative-tim.com/product/soft-ui-dashboard?AFFILIATE=128200) by Creative-Tim
12+
- ✅ `Docker`
13+
- ✅ `CI/CD` via Render
14+
15+
![Volt Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168843604-b026fd94-5969-4be7-81ac-5887cf0958e5.png)
16+
17+
<br />
18+
19+
## Start with `Docker`
20+
21+
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
22+
23+
```bash
24+
$ git clone https://github.com/app-generator/flask-v3-volt-dashboard.git
25+
$ cd flask-v3-volt-dashboard
26+
```
27+
28+
<br />
29+
30+
> 👉 **Step 2** - Start the APP in `Docker`
31+
32+
```bash
33+
$ docker-compose up --build
34+
```
35+
36+
Visit `http://localhost:5085` in your browser. The app should be up & running.
37+
38+
<br />
39+
40+
## Manual Build
41+
42+
> Download the code
43+
44+
```bash
45+
$ git clone https://github.com/app-generator/flask-v3-volt-dashboard.git
46+
$ cd flask-v3-volt-dashboard
47+
```
48+
49+
<br />
50+
51+
### 👉 Set Up for `Unix`, `MacOS`
52+
53+
> Install modules via `VENV`
54+
55+
```bash
56+
$ virtualenv env
57+
$ source env/bin/activate
58+
$ pip3 install -r requirements.txt
59+
```
60+
61+
<br />
62+
63+
> Set Up Flask Environment
64+
65+
```bash
66+
$ export FLASK_APP=run.py
67+
$ export FLASK_ENV=development
68+
```
69+
70+
<br />
71+
72+
> Start the app
73+
74+
```bash
75+
$ flask run
76+
```
77+
78+
At this point, the app runs at `http://127.0.0.1:5000/`.
79+
80+
<br />
81+
82+
### 👉 Set Up for `Windows`
83+
84+
> Install modules via `VENV` (windows)
85+
86+
```
87+
$ virtualenv env
88+
$ .\env\Scripts\activate
89+
$ pip3 install -r requirements.txt
90+
```
91+
92+
<br />
93+
94+
> Set Up Flask Environment
95+
96+
```bash
97+
$ # CMD
98+
$ set FLASK_APP=run.py
99+
$ set FLASK_ENV=development
100+
$
101+
$ # Powershell
102+
$ $env:FLASK_APP = ".\run.py"
103+
$ $env:FLASK_ENV = "development"
104+
```
105+
106+
<br />
107+
108+
> Start the app
109+
110+
```bash
111+
$ flask run
112+
```
113+
114+
At this point, the app runs at `http://127.0.0.1:5000/`.
115+
116+
<br />
117+
118+
## Codebase Structure
119+
120+
The project has a simple, intuitive structure presented bellow:
121+
122+
```bash
123+
< PROJECT ROOT >
124+
|
125+
|-- apps/__init__.py
126+
|-- apps/
127+
| |-- static/
128+
| | |-- <css, JS, images> # CSS files, Javascripts files
129+
| |
130+
| |-- templates/
131+
| |
132+
| |-- includes/ # Page chunks, components
133+
| | |
134+
| | |-- navigation.html # Top bar
135+
| | |-- sidebar.html # Left sidebar
136+
| | |-- scripts.html # JS scripts common to all pages
137+
| | |-- footer.html # The common footer
138+
| |
139+
| |-- layouts/ # App Layouts (the master pages)
140+
| | |
141+
| | |-- base.html # Used by common pages like index, UI
142+
| | |-- base-fullscreen.html # Used by auth pages (login, register)
143+
| |
144+
| index.html # The default page
145+
| page-404.html # Error 404 page (page not found)
146+
| page-500.html # Error 500 page (server error)
147+
| *.html # All other pages provided by the UI Kit
148+
|
149+
|-- requirements.txt
150+
|
151+
|-- run.py
152+
|
153+
|-- ************************************************************************
154+
```
155+
156+
<br />
157+
158+
## [Flask Soft Dashboard](https://appseed.us/product/soft-ui-dashboard-pro/flask/) `PRO`
159+
160+
> For more components, pages and priority on support, feel free to take a look at this starter:
161+
162+
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.
163+
164+
- 👉 [Flask Volt PRO](https://appseed.us/product/volt-dashboard-pro/flask/) - product page
165+
- 👉 [Flask Volt PRO](https://flask-volt-pro.appseed-srv1.com/) - LIVE deployment
166+
167+
![Flask Volt PRO - Premium Starter.](https://user-images.githubusercontent.com/51070104/167878207-37758fbf-fbea-4140-9232-d5bf0c6a1fe8.jpg)
168+
169+
<br />
170+
171+
---
172+
Volt Dashboard - Open-source Flask v3 starter provided by **[AppSeed](https://appseed.us/)**.

‎apps/__init__.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""
5+
6+
import os
7+
8+
# import Flask
9+
from flask import Flask
10+
11+
from .config import Config
12+
13+
# Inject Flask magic
14+
app = Flask(__name__)
15+
16+
# load Configuration
17+
app.config.from_object( Config )
18+
19+
# Import routing to render the pages
20+
from apps import views

‎apps/config.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""
5+
6+
import os
7+
8+
class Config(object):
9+
10+
basedir = os.path.abspath(os.path.dirname(__file__))
11+
12+
DEBUG = (os.getenv('DEBUG', 'False') == 'True')
13+
14+
# Assets Management
15+
ASSETS_ROOT = os.getenv('ASSETS_ROOT', '/static/assets')
16+
17+
# App Config - the minimal footprint
18+
SECRET_KEY = os.getenv('SECRET_KEY', 'S#perS3crEt_9999')

‎apps/static/.gitkeep‎

Whitespace-only changes.

‎apps/static/assets/.gitkeep‎

Whitespace-only changes.

‎apps/static/assets/img/brand/dark.svg‎

Lines changed: 13 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)