Skip to content

Commit 50ea08e

Browse files
author
App Generator
committed
Release v1.0.4 - Bump Codebase & Fixes
1 parent 7cd0988 commit 50ea08e

File tree

3 files changed

+104
-97
lines changed

3 files changed

+104
-97
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-09
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: 88 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
> Features
88
9+
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
10+
- [SCSS compilation](#recompile-css) via **Gulp**
911
- DBMS: SQLite, PostgreSQL (production)
1012
- DB Tools: SQLAlchemy ORM, Alembic (schema migrations)
1113
- Modular design with **Blueprints**, simple codebase
@@ -23,15 +25,25 @@
2325

2426
<br />
2527

26-
## Want more? Go PRO!
28+
## Quick Start in [Docker](https://www.docker.com/)
2729

28-
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
30+
> Get the code
2931
30-
| [Flask Datta PRO](https://appseed.us/admin-dashboards/flask-dashboard-dattaable-pro) | [Flask Soft PRO](https://appseed.us/product/flask-soft-ui-dashboard-pro) | [Flask Volt PRO](https://appseed.us/admin-dashboards/flask-dashboard-volt-pro) |
31-
| --- | --- | --- |
32-
| [![Flask Datta PRO](https://raw.githubusercontent.com/app-generator/flask-dashboard-dattaable-pro/master/media/flask-dashboard-dattaable-pro-screen.png)](https://appseed.us/admin-dashboards/flask-dashboard-dattaable-pro) | [![Flask Soft PRO](https://user-images.githubusercontent.com/51070104/131249807-f256efc6-2256-4bb1-9367-cc50ddd7ce18.png)](https://appseed.us/product/flask-soft-ui-dashboard-pro) | [![Flask Volt PRO](https://raw.githubusercontent.com/app-generator/flask-dashboard-volt-pro/master/media/flask-dashboard-volt-pro-screen.png)](https://appseed.us/admin-dashboards/flask-dashboard-volt-pro)
32+
```bash
33+
$ git clone https://github.com/app-generator/flask-dashboard-coreui.git
34+
$ cd flask-dashboard-coreui
35+
```
36+
37+
> Start the app in Docker
38+
39+
```bash
40+
$ docker-compose pull # download dependencies
41+
$ docker-compose build # local set up
42+
$ docker-compose up -d # start the app
43+
```
44+
45+
Visit `http://localhost:85` in your browser. The app should be up & running.
3346

34-
<br />
3547
<br />
3648

3749
![CoreUI Flask - Template project generated in Flask by AppSeed.](https://raw.githubusercontent.com/app-generator/flask-dashboard-coreui/master/media/flask-dashboard-coreui-screen.png)
@@ -85,24 +97,57 @@ $ # Access the dashboard in browser: http://127.0.0.1:5000/
8597

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

88-
> Simplified version
89-
90100
```bash
91101
< PROJECT ROOT >
92102
|
93-
|-- app/ # Implements app logic
94-
| |-- base/ # Base Blueprint - handles the authentication
95-
| |-- home/ # Home Blueprint - serve UI Kit pages
103+
|-- apps/
96104
| |
97-
| __init__.py # Initialize the app
105+
| |-- home/ # A simple app that serve HTML files
106+
| | |-- routes.py # Define app routes
107+
| |
108+
| |-- authentication/ # Handles auth routes (login and register)
109+
| | |-- routes.py # Define authentication routes
110+
| | |-- models.py # Defines models
111+
| | |-- forms.py # Define auth forms (login and register)
112+
| |
113+
| |-- static/
114+
| | |-- <css, JS, images> # CSS files, Javascripts files
115+
| |
116+
| |-- templates/ # Templates used to render pages
117+
| | |-- includes/ # HTML chunks and components
118+
| | | |-- navigation.html # Top menu component
119+
| | | |-- sidebar.html # Sidebar component
120+
| | | |-- footer.html # App Footer
121+
| | | |-- scripts.html # Scripts common to all pages
122+
| | |
123+
| | |-- layouts/ # Master pages
124+
| | | |-- base-fullscreen.html # Used by Authentication pages
125+
| | | |-- base.html # Used by common pages
126+
| | |
127+
| | |-- accounts/ # Authentication pages
128+
| | | |-- login.html # Login page
129+
| | | |-- register.html # Register page
130+
| | |
131+
| | |-- home/ # UI Kit Pages
132+
| | |-- index.html # Index page
133+
| | |-- 404-page.html # 404 page
134+
| | |-- *.html # All other pages
135+
| |
136+
| config.py # Set up the app
137+
| __init__.py # Initialize the app
138+
|
139+
|-- requirements.txt # Development modules - SQLite storage
140+
|-- requirements-mysql.txt # Production modules - Mysql DMBS
141+
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
98142
|
99-
|-- requirements.txt # Development modules - SQLite storage
100-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
101-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
143+
|-- Dockerfile # Deployment
144+
|-- docker-compose.yml # Deployment
145+
|-- gunicorn-cfg.py # Deployment
146+
|-- nginx # Deployment
147+
| |-- appseed-app.conf # Deployment
102148
|
103-
|-- .env # Inject Configuration via Environment
104-
|-- config.py # Set up the app
105-
|-- run.py # Start the app - WSGI gateway
149+
|-- .env # Inject Configuration via Environment
150+
|-- run.py # Start the app - WSGI gateway
106151
|
107152
|-- ************************************************************************
108153
```
@@ -121,105 +166,52 @@ The project is coded using blueprints, app factory pattern, dual configuration p
121166

122167
<br />
123168

124-
> App / Base Blueprint
169+
## Recompile CSS
125170

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-
```
171+
To recompile SCSS files, follow this setup:
163172

164173
<br />
165174

166-
> App / Home Blueprint
175+
**Step #1** - Install tools
167176

168-
The *Home* blueprint handles UI Kit pages for authenticated users. This is the private zone of the app - the structure is presented below:
177+
- [NodeJS](https://nodejs.org/en/) 12.x or higher
178+
- [Gulp](https://gulpjs.com/) - globally
179+
- `npm install -g gulp-cli`
180+
- [Yarn](https://yarnpkg.com/) (optional)
181+
182+
<br />
183+
184+
**Step #2** - Change the working directory to `assets` folder
169185

170186
```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-
|-- ************************************************************************
187+
$ cd apps/static/assets
194188
```
195189

196190
<br />
197191

198-
## Deployment
192+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
199193

200-
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/).
194+
```bash
195+
$ npm install
196+
// OR
197+
$ yarn
198+
```
201199

202200
<br />
203201

204-
### [Docker](https://www.docker.com/) execution
205-
---
206-
207-
The application can be easily executed in a docker container. The steps:
208-
209-
> Get the code
202+
**Step #4** - Edit & Recompile SCSS files
210203

211204
```bash
212-
$ git clone https://github.com/app-generator/flask-dashboard-coreui.git
213-
$ cd flask-dashboard-coreui
205+
$ gulp scss
214206
```
215207

216-
> Start the app in Docker
208+
The generated file is saved in `static/assets/css` directory.
217209

218-
```bash
219-
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
220-
```
210+
<br />
221211

222-
Visit `http://localhost:5005` in your browser. The app should be up & running.
212+
## Deployment
213+
214+
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/).
223215

224216
<br />
225217

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "flask-dashboard-coreui",
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)