Skip to content

Commit c94ccc2

Browse files
author
App Generator
committed
Release v1.0.3 - Bump Codebase Version
1 parent f67f701 commit c94ccc2

File tree

3 files changed

+89
-35
lines changed

3 files changed

+89
-35
lines changed

CHANGELOG.md

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

3+
## [1.0.3] 2021-12-12
4+
### Dependencies Update
5+
6+
- Bump [Flask Codebase](https://github.com/app-generator/boilerplate-code-flask) v1.0.7
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+
315
## [1.0.2] 2021-05-16
416
### Dependencies Update
517

README.md

Lines changed: 73 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
# [Soft UI Design System](https://appseed.us/ui-kit/soft-ui-design-system) Flask
1+
# [Soft UI Design Flask](https://appseed.us/product/flask-soft-ui-design-system)
22

3-
**[Soft UI Design System](https://appseed.us/ui-kit/soft-ui-design-system)** is a Premium Bootstrap 5 UI Kit designed by [Creative-Tim](https://bit.ly/3fKQZaL) designed for those who like bold elements and beautiful websites. **Soft UI Design System Flask** is a simple Flask starter provided by AppSeed with a modular codebase, database, authentication and deployment scripts - Features:
3+
**[Soft UI Design System](https://appseed.us/ui-kit/soft-ui-design-system)** is a Premium Bootstrap 5 UI Kit designed by [Creative-Tim](https://bit.ly/3fKQZaL) designed for those who like bold elements and beautiful websites. **Soft UI Design System Flask** is a simple Flask starter provided by AppSeed with a modular codebase, database, authentication, and deployment scripts - Features:
44

55
<br />
66

7+
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
8+
- [SCSS compilation](#recompile-css) via **Gulp**
79
- UI Kit: **Soft UI Design System** (Free Version) by **Creative-Tim**
810
- SQLite database, Flask-SQLAlchemy ORM
911
- Session-Based auth flow (login, register)
@@ -14,20 +16,32 @@
1416

1517
> Links
1618
17-
- [Soft UI Design System Flask](https://appseed.us/product/flask-soft-ui-design-system) - product page
18-
- [Soft UI Design System Flask - Demo](https://flask-soft-ui-free.appseed-srv1.com/) - LIVE Deployment
19+
- [Soft UI Design Flask](https://appseed.us/product/flask-soft-ui-design-system) - Product page
20+
- [Soft UI Design Flask ](https://flask-soft-ui-free.appseed-srv1.com/) - LIVE Demo
1921

2022
<br />
2123

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

24-
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
26+
> Get the code
27+
28+
```bash
29+
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
30+
$ cd flask-soft-ui-design
31+
```
32+
33+
> Start the app in Docker
34+
35+
```bash
36+
$ docker-compose up --build
37+
```
2538

26-
| [Flask Soft UI PRO](https://appseed.us/product/flask-soft-ui-pro) | [Flask Material PRO](https://appseed.us/admin-dashboards/flask-dashboard-material-pro) | [Flask Volt PRO](https://appseed.us/admin-dashboards/flask-dashboard-volt-pro) |
27-
| --- | --- | --- |
28-
| [![Flask Soft UI PRO](https://raw.githubusercontent.com/app-generator/soft-ui-design-system/main/media/soft-ui-design-system-screen.png)](https://appseed.us/product/flask-soft-ui-pro) | [![Flask Material PRO](https://raw.githubusercontent.com/app-generator/flask-dashboard-material-pro/master/media/flask-dashboard-material-pro-screen.png)](https://appseed.us/admin-dashboards/flask-dashboard-material-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)
39+
Visit `http://localhost:85` in your browser. The app should be up & running.
2940

3041
<br />
42+
43+
![Flask Material Kit 2 - Starter provided by AppSeed.](https://user-images.githubusercontent.com/51070104/139474054-a223e8e0-d441-4f9f-8237-627a77bdd49c.gif)
44+
3145
<br />
3246

3347
![Flask Template - Starter provided by AppSeed.](https://raw.githubusercontent.com/app-generator/flask-soft-ui-free/master/media/flask-soft-ui-free-screen.png)
@@ -38,8 +52,8 @@ PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Suppo
3852

3953
```bash
4054
$ # Clone the sources
41-
$ git clone https://github.com/app-generator/flask-soft-ui-free.git
42-
$ cd flask-soft-ui-free
55+
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
56+
$ cd flask-soft-ui-design
4357
$
4458
$ # Virtualenv modules installation (Unix based systems)
4559
$ virtualenv env
@@ -81,7 +95,6 @@ The project has a super simple structure, represented as bellow:
8195
```bash
8296
< PROJECT ROOT >
8397
|
84-
|-- app/__init__.py
8598
|-- app/
8699
| |-- static/
87100
| | |-- <css, JS, images> # CSS files, Javascripts files
@@ -105,48 +118,77 @@ The project has a super simple structure, represented as bellow:
105118
| | | |-- login.html # Use layout `base-fullscreen.html`
106119
| | | |-- register.html # Use layout `base-fullscreen.html`
107120
| | |
108-
| | index.html # The default page
109-
| | page-404.html # Error 404 page (page not found)
110-
| | page-500.html # Error 500 page (server error)
111-
| | *.html # All other pages provided by the UI Kit
121+
| | |-- home/ # UI Kit Pages
122+
| | |-- index.html # Index page
123+
| | |-- 404-page.html # 404 page
124+
| | |-- *.html # All other pages
125+
| |
126+
| config.py # Provides APP Configuration
127+
| forms.py # Defines Forms (login, register)
128+
| models.py # Defines app models
129+
| views.py # Application Routes
112130
|
113-
|-- requirements.txt
131+
|-- Dockerfile # Deployment
132+
|-- docker-compose.yml # Deployment
133+
|-- gunicorn-cfg.py # Deployment
134+
|-- nginx # Deployment
135+
| |-- appseed-app.conf # Deployment
114136
|
137+
|-- requirements.txt
115138
|-- run.py
116139
|
117140
|-- ************************************************************************
118141
```
119142

120143
<br />
121144

122-
## Deployment
145+
## Recompile CSS
123146

124-
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Heroku](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
147+
To recompile SCSS files, follow this setup:
125148

126149
<br />
127150

128-
### [Docker](https://www.docker.com/) execution
129-
---
151+
**Step #1** - Install tools
130152

131-
The application can be easily executed in a docker container. The steps:
153+
- [NodeJS](https://nodejs.org/en/) 12.x or higher
154+
- [Gulp](https://gulpjs.com/) - globally
155+
- `npm install -g gulp-cli`
156+
- [Yarn](https://yarnpkg.com/) (optional)
132157

133-
> Get the code
158+
<br />
159+
160+
**Step #2** - Change the working directory to `assets` folder
134161

135162
```bash
136-
$ git clone https://github.com/app-generator/flask-soft-ui-free.git
137-
$ cd flask-soft-ui-free
163+
$ cd app/static/assets
138164
```
139165

140-
> Start the app in Docker
166+
<br />
167+
168+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
169+
170+
```bash
171+
$ npm install
172+
// OR
173+
$ yarn
174+
```
175+
176+
<br />
177+
178+
**Step #4** - Edit & Recompile SCSS files
141179

142180
```bash
143-
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
181+
$ gulp scss
144182
```
145183

146-
Visit `http://localhost:5005` in your browser. The app should be up & running.
184+
The generated file is saved in `static/assets/css` directory.
147185

148186
<br />
149187

188+
## Deployment
189+
190+
The app is provided with a basic configuration to be executed in [Docker](https://www.docker.com/), [Heroku](https://www.heroku.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
191+
150192
### [Heroku](https://www.heroku.com/)
151193
---
152194

@@ -159,8 +201,8 @@ Steps to deploy on **Heroku**
159201

160202
```bash
161203
$ # Clone the source code:
162-
$ git clone https://github.com/app-generator/flask-soft-ui-free.git
163-
$ cd flask-soft-ui-free
204+
$ git clone https://github.com/app-generator/flask-soft-ui-design.git
205+
$ cd flask-soft-ui-design
164206
$
165207
$ # Check Heroku CLI is installed
166208
$ heroku -v
@@ -241,4 +283,4 @@ You will save a lot of time going from prototyping to full-functional code, beca
241283
<br />
242284

243285
---
244-
[Soft UI Design System](https://appseed.us/ui-kit/soft-ui-design-system) Flask - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).
286+
[Soft UI Design Flask](https://appseed.us/product/flask-soft-ui-design-system) - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
{
2-
"name": "flask-soft-ui-free",
2+
"name": "flask-soft-ui-design",
33
"mastertemplate": "boilerplate-code-flask",
4-
"version": "1.0.2",
4+
"version": "1.0.3",
55
"description": "Template project - Flask Boilerplate Code",
66
"scripts": {},
77
"repository": {
88
"type": "git",
9-
"url": "https://github.com/app-generator/flask-soft-ui-free"
9+
"url": "https://github.com/app-generator/flask-soft-ui-design"
1010
},
1111
"bugs": {
12-
"url": "https://github.com/app-generator/flask-soft-ui-free/issues",
12+
"url": "https://github.com/app-generator/flask-soft-ui-design/issues",
1313
"email": "support@appseed.us"
1414
},
1515
"author": "AppSeed App Generator <support@appseed.us> (https://appseed.us)",

0 commit comments

Comments
 (0)