Skip to content

Commit 36f190a

Browse files
author
App Generator
committed
Release v1.0.1 - Bump Codebase Version
1 parent ad0fcc1 commit 36f190a

File tree

2 files changed

+85
-128
lines changed

2 files changed

+85
-128
lines changed

‎CHANGELOG.md

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

3+
## [1.0.1] 2021-12-04
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+
- Fixes:
15+
- ImportError: cannot import name 'TextField' from 'wtforms'
16+
317
## [1.0.0] 2021-06-25
418
### Initial release
519

‎README.md

Lines changed: 71 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Soft Dashboard PRO Flask
1+
# [Soft UI Dashboard PRO Flask](https://appseed.us/product/flask-soft-ui-dashboard-pro)
22

3-
**Flask Seed Project** provided by AppSeed on top of **[Soft UI Dashboard PRO](https://appseed.us/product/flask-soft-ui-dashboard-pro)**, a modern Bootstrap 5 design from Creative-Tim. The project might help beginners to code simple presentation websites on top of the existing codebase OR migrate the `production-ready` UI to a legacy Python-based project compatible with **Jinja Template Engine**: *Flask*, *Django*, *Bottle* of *FastAPI*.
3+
**Flask Seed Project** provided by AppSeed on top of **Soft UI Dashboard PRO**, a modern Bootstrap 5 design from Creative-Tim. The project might help beginners to code simple presentation websites on top of the existing codebase OR migrate the `production-ready` UI to a legacy Python-based project compatible with **Jinja Template Engine**: *Flask*, *Django*, *Bottle* of *FastAPI*.
44

55
<br />
66

7-
- UI Kit: **[Soft UI Dashboard](https://bit.ly/2RtSXVa)** (PRO Version) by **Creative-Tim**
7+
- `Up-to-date dependencies`: **Flask 2.0.1**
8+
- [SCSS compilation](#recompile-css) via **Gulp**
9+
- UI Kit: **[Soft UI Dashboard PRO](https://bit.ly/2RtSXVa)** (Free Version) by **Creative-Tim**
810
- DBMS: SQLite, PostgreSQL (production)
911
- DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
1012
- Modular design with **Blueprints**
@@ -21,22 +23,28 @@
2123

2224
<br />
2325

24-
## Buy Product (via PayPal)
26+
## Quick Start in [Docker](https://www.docker.com/)
2527

26-
- **$99** - [Soft UI Dashboard PRO Flask](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZCA4T3KR3CVSC) - **[Personal License](https://github.com/app-generator/license-personal)**
27-
- **$79** - [Soft UI Dashboard PRO Flask](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9PWSX92QXSB86) - **[EDU License](https://github.com/app-generator/license-education)**
28+
> Get the code
2829
29-
<br />
30+
```bash
31+
$ git clone https://github.com/app-generator/priv-flask-soft-ui-dashboard-pro.git
32+
$ cd priv-flask-soft-ui-dashboard-pro
33+
```
3034

31-
## [Soft UI Dashboard PRO](https://bit.ly/2RtSXVa)
35+
> Start the app in Docker
3236
33-
The most complex and innovative Dashboard Made by Creative Tim: made of hundred of elements, designed blocks and fully coded pages, Soft UI Dashboard is ready to help you create stunning websites and web apps.
37+
```bash
38+
$ docker-compose pull # download dependencies
39+
$ docker-compose build # local set up
40+
$ docker-compose up -d # start the app
41+
```
3442

35-
**Fully Coded Elements** - Soft UI Dashboard PRO is built with over 300 frontend individual elements, like buttons, inputs, navbars, navtabs, cards or alerts, giving you the freedom of choosing and combining. All components can take variations in colour, that you can easily modify using SASS files and classes.
43+
Visit `http://localhost:85` in your browser. The app should be up & running.
3644

3745
<br />
3846

39-
![Soft UI Dashboard PR0 - Flask Seed Project.](https://user-images.githubusercontent.com/51070104/131249807-f256efc6-2256-4bb1-9367-cc50ddd7ce18.png)
47+
![Soft UI Dashboard PR0 - Flask Seed Project.](https://user-images.githubusercontent.com/51070104/123518571-1f703400-d6af-11eb-8aab-cf1b9c5e2763.png)
4048

4149
<br />
4250

@@ -82,24 +90,57 @@ $ # Access the dashboard in browser: http://127.0.0.1:5000/
8290

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

85-
> Simplified version
86-
8793
```bash
8894
< PROJECT ROOT >
8995
|
90-
|-- app/ # Implements app logic
91-
| |-- base/ # Base Blueprint - handles the authentication
92-
| |-- home/ # Home Blueprint - serve UI Kit pages
96+
|-- apps/
97+
| |
98+
| |-- home/ # A simple app that serve HTML files
99+
| | |-- routes.py # Define app routes
100+
| |
101+
| |-- authentication/ # Handles auth routes (login and register)
102+
| | |-- routes.py # Define authentication routes
103+
| | |-- models.py # Defines models
104+
| | |-- forms.py # Define auth forms (login and register)
93105
| |
94-
| __init__.py # Initialize the app
106+
| |-- static/
107+
| | |-- <css, JS, images> # CSS files, Javascripts files
108+
| |
109+
| |-- templates/ # Templates used to render pages
110+
| | |-- includes/ # HTML chunks and components
111+
| | | |-- navigation.html # Top menu component
112+
| | | |-- sidebar.html # Sidebar component
113+
| | | |-- footer.html # App Footer
114+
| | | |-- scripts.html # Scripts common to all pages
115+
| | |
116+
| | |-- layouts/ # Master pages
117+
| | | |-- base-fullscreen.html # Used by Authentication pages
118+
| | | |-- base.html # Used by common pages
119+
| | |
120+
| | |-- accounts/ # Authentication pages
121+
| | | |-- login.html # Login page
122+
| | | |-- register.html # Register page
123+
| | |
124+
| | |-- home/ # UI Kit Pages
125+
| | |-- index.html # Index page
126+
| | |-- 404-page.html # 404 page
127+
| | |-- *.html # All other pages
128+
| |
129+
| config.py # Set up the app
130+
| __init__.py # Initialize the app
131+
|
132+
|-- requirements.txt # Development modules - SQLite storage
133+
|-- requirements-mysql.txt # Production modules - Mysql DMBS
134+
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
95135
|
96-
|-- requirements.txt # Development modules - SQLite storage
97-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
98-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
136+
|-- Dockerfile # Deployment
137+
|-- docker-compose.yml # Deployment
138+
|-- gunicorn-cfg.py # Deployment
139+
|-- nginx # Deployment
140+
| |-- appseed-app.conf # Deployment
99141
|
100-
|-- .env # Inject Configuration via Environment
101-
|-- config.py # Set up the app
102-
|-- run.py # Start the app - WSGI gateway
142+
|-- .env # Inject Configuration via Environment
143+
|-- run.py # Start the app - WSGI gateway
103144
|
104145
|-- ************************************************************************
105146
```
@@ -118,80 +159,6 @@ The project is coded using blueprints, app factory pattern, dual configuration p
118159

119160
<br />
120161

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

197164
To recompile SCSS files, follow this setup:
@@ -210,7 +177,7 @@ To recompile SCSS files, follow this setup:
210177
**Step #2** - Change the working directory to `assets` folder
211178

212179
```bash
213-
$ cd app/base/static/assets
180+
$ cd apps/static/assets
214181
```
215182

216183
<br />
@@ -228,41 +195,17 @@ $ yarn
228195
**Step #4** - Edit & Recompile SCSS files
229196

230197
```bash
231-
$ gulp
198+
$ gulp scss
232199
```
233200

234-
The generated files (css, min.css) are saved in `static/assets/css` directory.
201+
The generated file is saved in `static/assets/css` directory.
235202

236-
<br />
203+
<br />
237204

238205
## Deployment
239206

240207
The project comes with a basic configuration for [Docker](https://www.docker.com/), [HEROKU](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
241208

242-
<br />
243-
244-
### [Docker](https://www.docker.com/) execution
245-
---
246-
247-
The steps to start the template using Docker:
248-
249-
> Get the code
250-
251-
```bash
252-
$ git clone https://github.com/app-generator/priv-flask-soft-ui-dashboard-pro.git
253-
$ cd priv-flask-soft-ui-dashboard-pro
254-
```
255-
256-
> Start the app in Docker
257-
258-
```bash
259-
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
260-
```
261-
262-
Visit `http://localhost:5005` in your browser. The app should be up & running.
263-
264-
<br />
265-
266209
### [Heroku](https://www.heroku.com/)
267210
---
268211

@@ -275,8 +218,8 @@ Steps to deploy on **Heroku**
275218

276219
```bash
277220
$ # Clone the source code:
278-
$ git clone https://github.com/app-generator/priv-jinja-soft-ui-dashboard-pro.git
279-
$ cd priv-jinja-soft-ui-dashboard-pro
221+
$ git clone https://github.com/app-generator/priv-flask-soft-ui-dashboard-pro.git
222+
$ cd priv-flask-soft-ui-dashboard-pro
280223
$
281224
$ # Check Heroku CLI is installed
282225
$ heroku -v
@@ -347,4 +290,4 @@ Visit `http://localhost:8001` in your browser. The app should be up & running.
347290
<br />
348291

349292
---
350-
Soft UI Dashboard PRO Flask - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).
293+
[Soft UI Dashboard PRO Flask](https://appseed.us/product/flask-soft-ui-dashboard-pro) - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).

0 commit comments

Comments
 (0)