Skip to content

Commit ba86c55

Browse files
author
App Generator
committed
Release v1.0.4 - Bump Codebase Version
1 parent 18d4ded commit ba86c55

File tree

3 files changed

+63
-88
lines changed

3 files changed

+63
-88
lines changed

‎CHANGELOG.md‎

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

3+
## [1.0.4] 2021-11-08
4+
### Improvements
5+
6+
- Bump Codebase: [Flask Dashboard](https://github.com/app-generator/boilerplate-code-flask-dashboard) v2.0.0
7+
- Dependencies update (all packages)
8+
- Flask==2.0.1 (latest stable version)
9+
- Better Code formatting
10+
- Improved Files organization
11+
- Optimize imports
12+
- Docker Scripts Update
13+
- Gulp Tooling (SASS Compilation)
14+
- Fix **ImportError: cannot import name 'TextField' from 'wtforms'**
15+
- Problem caused by `WTForms-3.0.0`
16+
- Fix: use **WTForms==2.3.3**
17+
318
## [1.0.3] 2021-05-16
419
### Dependencies Update
520

‎README.md‎

Lines changed: 47 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Open-source dashboard generated by AppSeed in **Flask** Framework. [Gradient Abl
66

77
> Features
88
9+
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
910
- DBMS: SQLite, PostgreSQL (production)
1011
- DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
1112
- Modular design with **Blueprints**, simple codebase
@@ -85,24 +86,57 @@ $ # Access the dashboard in browser: http://127.0.0.1:5000/
8586

8687
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
8788

88-
> Simplified version
89-
9089
```bash
9190
< PROJECT ROOT >
9291
|
93-
|-- app/ # Implements app logic
94-
| |-- base/ # Base Blueprint - handles the authentication
95-
| |-- home/ # Home Blueprint - serve UI Kit pages
92+
|-- apps/
93+
| |
94+
| |-- home/ # A simple app that serve HTML files
95+
| | |-- routes.py # Define app routes
96+
| |
97+
| |-- authentication/ # Handles auth routes (login and register)
98+
| | |-- routes.py # Define authentication routes
99+
| | |-- models.py # Defines models
100+
| | |-- forms.py # Define auth forms (login and register)
101+
| |
102+
| |-- static/
103+
| | |-- <css, JS, images> # CSS files, Javascripts files
96104
| |
97-
| __init__.py # Initialize the app
105+
| |-- templates/ # Templates used to render pages
106+
| | |-- includes/ # HTML chunks and components
107+
| | | |-- navigation.html # Top menu component
108+
| | | |-- sidebar.html # Sidebar component
109+
| | | |-- footer.html # App Footer
110+
| | | |-- scripts.html # Scripts common to all pages
111+
| | |
112+
| | |-- layouts/ # Master pages
113+
| | | |-- base-fullscreen.html # Used by Authentication pages
114+
| | | |-- base.html # Used by common pages
115+
| | |
116+
| | |-- accounts/ # Authentication pages
117+
| | | |-- login.html # Login page
118+
| | | |-- register.html # Register page
119+
| | |
120+
| | |-- home/ # UI Kit Pages
121+
| | |-- index.html # Index page
122+
| | |-- 404-page.html # 404 page
123+
| | |-- *.html # All other pages
124+
| |
125+
| config.py # Set up the app
126+
| __init__.py # Initialize the app
98127
|
99-
|-- requirements.txt # Development modules - SQLite storage
100-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
101-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
128+
|-- requirements.txt # Development modules - SQLite storage
129+
|-- requirements-mysql.txt # Production modules - Mysql DMBS
130+
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
102131
|
103-
|-- .env # Inject Configuration via Environment
104-
|-- config.py # Set up the app
105-
|-- run.py # Start the app - WSGI gateway
132+
|-- Dockerfile # Deployment
133+
|-- docker-compose.yml # Deployment
134+
|-- gunicorn-cfg.py # Deployment
135+
|-- nginx # Deployment
136+
| |-- appseed-app.conf # Deployment
137+
|
138+
|-- .env # Inject Configuration via Environment
139+
|-- run.py # Start the app - WSGI gateway
106140
|
107141
|-- ************************************************************************
108142
```
@@ -116,85 +150,11 @@ The project is coded using blueprints, app factory pattern, dual configuration p
116150
- If env.DEBUG is set to *True* the SQLite storage is used
117151
- If env.DEBUG is set to *False* the specified DB driver is used (MySql, PostgreSQL)
118152
- Call the app factory method `create_app` defined in app/__init__.py
119-
- Redirect the guest users to Login page
153+
- Redirect the guest users to Login page
120154
- Unlock the pages served by *home* blueprint for authenticated users
121155

122156
<br />
123157

124-
> App / Base Blueprint
125-
126-
The *Base* blueprint handles the authentication (routes and forms) and assets management. The structure is presented below:
127-
128-
```bash
129-
< PROJECT ROOT >
130-
|
131-
|-- app/
132-
| |-- home/ # Home Blueprint - serve app pages (private area)
133-
| |-- base/ # Base Blueprint - handles the authentication
134-
| |-- static/
135-
| | |-- <css, JS, images> # CSS files, Javascripts files
136-
| |
137-
| |-- templates/ # Templates used to render pages
138-
| |
139-
| |-- includes/ #
140-
| | |-- navigation.html # Top menu component
141-
| | |-- sidebar.html # Sidebar component
142-
| | |-- footer.html # App Footer
143-
| | |-- scripts.html # Scripts common to all pages
144-
| |
145-
| |-- layouts/ # Master pages
146-
| | |-- base-fullscreen.html # Used by Authentication pages
147-
| | |-- base.html # Used by common pages
148-
| |
149-
| |-- accounts/ # Authentication pages
150-
| |-- login.html # Login page
151-
| |-- register.html # Registration page
152-
|
153-
|-- requirements.txt # Development modules - SQLite storage
154-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
155-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
156-
|
157-
|-- .env # Inject Configuration via Environment
158-
|-- config.py # Set up the app
159-
|-- run.py # Start the app - WSGI gateway
160-
|
161-
|-- ************************************************************************
162-
```
163-
164-
<br />
165-
166-
> App / Home Blueprint
167-
168-
The *Home* blueprint handles UI Kit pages for authenticated users. This is the private zone of the app - the structure is presented below:
169-
170-
```bash
171-
< PROJECT ROOT >
172-
|
173-
|-- app/
174-
| |-- base/ # Base Blueprint - handles the authentication
175-
| |-- home/ # Home Blueprint - serve app pages (private area)
176-
| |
177-
| |-- templates/ # UI Kit Pages
178-
| |
179-
| |-- index.html # Default page
180-
| |-- page-404.html # Error 404 page
181-
| |-- page-500.html # Error 500 page
182-
| |-- page-403.html # Error 403 page
183-
| |-- *.html # All other HTML pages
184-
|
185-
|-- requirements.txt # Development modules - SQLite storage
186-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
187-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
188-
|
189-
|-- .env # Inject Configuration via Environment
190-
|-- config.py # Set up the app
191-
|-- run.py # Start the app - WSGI gateway
192-
|
193-
|-- ************************************************************************
194-
```
195-
196-
<br />
197-
198158
## Deployment
199159

200160
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "flask-gradient-able",
33
"mastertemplate": "boilerplate-code-flask-dashboard",
4-
"version": "1.0.3",
4+
"version": "1.0.4",
55
"description": "Template project - Flask Boilerplate Code",
66
"repository": {
77
"type": "git",

0 commit comments

Comments
 (0)