Skip to content

Commit 914179b

Browse files
author
App Generator
committed
Release v1.0.2 - Bump Codebase Version
1 parent fdd5f9e commit 914179b

File tree

3 files changed

+107
-110
lines changed

3 files changed

+107
-110
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.2] 2021-11-29
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+
315
## [1.0.1] 2021-02-04
416
### Improvements
517

‎README.md‎

Lines changed: 94 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,48 @@
1-
# [Flask Dashboard](https://appseed.us/admin-dashboards/flask) Now UI
1+
# [Flask Now UI Dashboard](https://appseed.us/admin-dashboards/flask-now-ui-dashboard)
22

3-
[Admin dashboard](https://appseed.us/admin-dashboards) generated by AppSeed in **[Flask](https://appseed.us/admin-dashboards/flask)** Framework.
4-
5-
Now UI Dashboard is a responsive Bootstrap 4 kit provided for free by Invision and Creative Tim. Now UI Dashboard comes packed with all plugins that you might need inside a project and documentation on how to get started. It is light and easy to use, and also very powerful.
3+
Admin dashboard generated by AppSeed in **Flask** Framework. **Now UI Dashboard** is a responsive Bootstrap 4 kit provided for free by Invision and Creative Tim. Now UI Dashboard comes packed with all plugins that you might need inside a project and documentation on how to get started. It is light and easy to use, and also very powerful.
64

75
<br />
86

97
> Features
108
9+
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
10+
- [SCSS compilation](#recompile-css) via **Gulp**
11+
- UI: **[Black Dashboard](https://bit.ly/2L0W6Z7)** v1.0.1 provided by *Creative-Tim*
1112
- DBMS: SQLite, PostgreSQL (production)
12-
- DB Tools: SQLAlchemy ORM, Alembic (schema migrations)
13+
- DB Tools: SQLAlchemy ORM, Flask-Migrate (schema migrations)
1314
- Modular design with **Blueprints**, simple codebase
1415
- Session-Based authentication (via **flask_login**), Forms validation
15-
- Deployment scripts: Docker, Gunicorn / Nginx, Heroku
16+
- Deployment scripts: Docker, Gunicorn / Nginx, Heroku
1617
- Support via **Github** and [Discord](https://discord.gg/fZC6hup).
1718

1819
<br />
1920

2021
> Links
2122
22-
- [Flask Now UI](https://appseed.us/admin-dashboards/flask-now-ui-dashboard) - Product page
23-
- [Flask Now UI - Demo](https://flask-now-ui-dashboard.appseed-srv1.com) - LIVE App deployment
24-
- [Flask Tutorial](https://github.com/app-generator/tutorial-flask) - Getting started with Flask
23+
- [Flask Now UI Dashboard](https://appseed.us/admin-dashboards/flask-now-ui-dashboard) - Product page
24+
- [Flask Now UI Dashboard](https://flask-now-ui-dashboard.appseed-srv1.com) - LIVE App deployment
2525

2626
<br />
2727

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

30-
PRO versions include **Premium UI Kits**, Lifetime updates and **24/7 LIVE Support** (via [Discord](https://discord.gg/fZC6hup))
30+
> Get the code
3131
32-
| [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) |
33-
| --- | --- | --- |
34-
| [![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-now-ui-dashboard.git
34+
$ cd flask-now-ui-dashboard
35+
```
3536

36-
<br />
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+
```
3744

38-
![Flask Dashboard Now UI - Open-Source Flask Dashboard.](https://raw.githubusercontent.com/app-generator/flask-now-ui-dashboard/master/media/flask-now-ui-dashboard-screen.png)
45+
Visit `http://localhost:85` in your browser. The app should be up & running.
3946

4047
<br />
4148

@@ -82,28 +89,61 @@ $ # Access the dashboard in browser: http://127.0.0.1:5000/
8289
8390
<br />
8491

85-
## Codebase structure
92+
## Code-base structure
8693

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

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

123163
<br />
124164

125-
> App / Base Blueprint
165+
## Recompile CSS
126166

127-
The *Base* blueprint handles the authentication (routes and forms) and assets management. The structure is presented below:
128-
129-
```bash
130-
< PROJECT ROOT >
131-
|
132-
|-- app/
133-
| |-- home/ # Home Blueprint - serve app pages (private area)
134-
| |-- base/ # Base Blueprint - handles the authentication
135-
| |-- static/
136-
| | |-- <css, JS, images> # CSS files, Javascripts files
137-
| |
138-
| |-- templates/ # Templates used to render pages
139-
| |
140-
| |-- includes/ #
141-
| | |-- navigation.html # Top menu component
142-
| | |-- sidebar.html # Sidebar component
143-
| | |-- footer.html # App Footer
144-
| | |-- scripts.html # Scripts common to all pages
145-
| |
146-
| |-- layouts/ # Master pages
147-
| | |-- base-fullscreen.html # Used by Authentication pages
148-
| | |-- base.html # Used by common pages
149-
| |
150-
| |-- accounts/ # Authentication pages
151-
| |-- login.html # Login page
152-
| |-- register.html # Registration page
153-
|
154-
|-- requirements.txt # Development modules - SQLite storage
155-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
156-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
157-
|
158-
|-- .env # Inject Configuration via Environment
159-
|-- config.py # Set up the app
160-
|-- run.py # Start the app - WSGI gateway
161-
|
162-
|-- ************************************************************************
163-
```
167+
To recompile SCSS files, follow this setup:
164168

165169
<br />
166170

167-
> App / Home Blueprint
171+
**Step #1** - Install tools
168172

169-
The *Home* blueprint handles UI Kit pages for authenticated users. This is the private zone of the app - the structure is presented below:
170-
171-
```bash
172-
< PROJECT ROOT >
173-
|
174-
|-- app/
175-
| |-- base/ # Base Blueprint - handles the authentication
176-
| |-- home/ # Home Blueprint - serve app pages (private area)
177-
| |
178-
| |-- templates/ # UI Kit Pages
179-
| |
180-
| |-- index.html # Default page
181-
| |-- page-404.html # Error 404 - mandatory page
182-
| |-- page-500.html # Error 500 - mandatory page
183-
| |-- page-403.html # Error 403 - mandatory page
184-
| |-- *.html # All other HTML pages
185-
|
186-
|-- requirements.txt # Development modules - SQLite storage
187-
|-- requirements-mysql.txt # Production modules - Mysql DMBS
188-
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
189-
|
190-
|-- .env # Inject Configuration via Environment
191-
|-- config.py # Set up the app
192-
|-- run.py # Start the app - WSGI gateway
193-
|
194-
|-- ************************************************************************
195-
```
173+
- [NodeJS](https://nodejs.org/en/) 12.x or higher
174+
- [Gulp](https://gulpjs.com/) - globally
175+
- `npm install -g gulp-cli`
176+
- [Yarn](https://yarnpkg.com/) (optional)
196177

197178
<br />
198179

199-
## Deployment
180+
**Step #2** - Change the working directory to `assets` folder
200181

201-
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/).
182+
```bash
183+
$ cd apps/static/assets
184+
```
202185

203186
<br />
204187

205-
### [Docker](https://www.docker.com/) execution
206-
---
207-
208-
The application can be easily executed in a docker container. The steps:
209-
210-
> Get the code
188+
**Step #3** - Install modules (this will create a classic `node_modules` directory)
211189

212190
```bash
213-
$ git clone https://github.com/app-generator/flask-now-ui-dashboard.git
214-
$ cd flask-now-ui-dashboard
191+
$ npm install
192+
// OR
193+
$ yarn
215194
```
216195

217-
> Start the app in Docker
196+
<br />
197+
198+
**Step #4** - Edit & Recompile SCSS files
218199

219200
```bash
220-
$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
201+
$ gulp scss
221202
```
222203

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

225206
<br />
226207

208+
## Deployment
209+
210+
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/).
211+
227212
### [Heroku](https://www.heroku.com/)
228213
---
229214

@@ -310,4 +295,4 @@ Visit `http://localhost:8001` in your browser. The app should be up & running.
310295
<br />
311296

312297
---
313-
[Flask Dashboard](https://appseed.us/admin-dashboards/flask) Now UI - Provided by **AppSeed [App Generator](https://appseed.us/app-generator)**.
298+
[Flask Now UI Dashboard](https://appseed.us/admin-dashboards/flask-now-ui-dashboard) - Provided by **AppSeed [App Generator](https://appseed.us/app-generator)**.

‎package.json‎

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

0 commit comments

Comments
 (0)