nimmis/black-dashboard-flask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Release v1.0.4 - Bump Codebase & Fixes

Browse Source
This commit is contained in:
App Generator
2021-11-10 17:17:55 +02:00
parent 32f93f463e
commit 295e1a78e6
3 changed files with 140 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CHANGELOG.md
View File

@ -1,5 +1,19 @@
# Change Log # Change Log
## [1.0.4] 2021-11-10
### Improvements
- Bump Codebase: [Flask Dashboard](https://github.com/app-generator/boilerplate-code-flask-dashboard) v2.0.0
- Dependencies update (all packages)
- Flask==2.0.1 (latest stable version)
- Better Code formatting
- Improved Files organization
- Optimize imports
- Docker Scripts Update
- Gulp Tooling (SASS Compilation)
- Fixes:
- Import error caused by WTForms
## [1.0.3] 2021-05-16 ## [1.0.3] 2021-05-16
### Dependencies Update ### Dependencies Update

152
README.md
View File

@ -8,6 +8,8 @@
> Free product - **Flask Dashboard** starter project - Features: > Free product - **Flask Dashboard** starter project - Features:
- Up-to-date [dependencies](./requirements.txt): **Flask 2.0.1**
- [SCSS compilation](#recompile-css) via **Gulp**
- UI Kit: **Black Dashboard** (Free Version) provided by **[Creative-Tim](https://www.creative-tim.com/)** - UI Kit: **Black Dashboard** (Free Version) provided by **[Creative-Tim](https://www.creative-tim.com/)**
- Flask Codebase - provided by **[AppSeed](https://appseed.us/)** - Flask Codebase - provided by **[AppSeed](https://appseed.us/)**
- SQLite, PostgreSQL, SQLAlchemy ORM - SQLite, PostgreSQL, SQLAlchemy ORM
@ -22,6 +24,7 @@
## Table of Contents ## Table of Contents
* [Demo](#demo) * [Demo](#demo)
* [Docker Support](#docker-support)
* [Quick Start](#quick-start) * [Quick Start](#quick-start)
* [Documentation](#documentation) * [Documentation](#documentation)
* [File Structure](#file-structure) * [File Structure](#file-structure)
@ -42,6 +45,27 @@
<br /> <br />
## Docker SUpport
> Get the code
```bash
$ git clone https://github.com/app-generator/black-dashboard-flask.git
$ cd black-dashboard-flask
```
> Start the app in Docker
```bash
$ docker-compose pull # download dependencies
$ docker-compose build # local set up
$ docker-compose up -d # start the app
```
Visit `http://localhost:85` in your browser. The app should be up & running.
<br />
## Quick start ## Quick start
> UNZIP the sources or clone the private repository. After getting the code, open a terminal and navigate to the working directory, with product source code. > UNZIP the sources or clone the private repository. After getting the code, open a terminal and navigate to the working directory, with product source code.
@ -98,41 +122,115 @@ Within the download you'll find the following directories and files:
```bash ```bash
< PROJECT ROOT > < PROJECT ROOT >
| |
|-- app/ |-- apps/
| |-- home/ # Home Blueprint - serve app pages (private area) | |
| |-- base/ # Base Blueprint - handles the authentication | |-- home/ # A simple app that serve HTML files
| |-- static/ | | |-- routes.py # Define app routes
| | |-- <css, JS, images> # CSS files, Javascripts files | |
| | | |-- authentication/ # Handles auth routes (login and register)
| |-- templates/ # Templates used to render pages | | |-- routes.py # Define authentication routes
| | | | |-- models.py # Defines models
| |-- includes/ # | | |-- forms.py # Define auth forms (login and register)
| | |-- navigation.html # Top menu component | |
| | |-- sidebar.html # Sidebar component | |-- static/
| | |-- footer.html # App Footer | | |-- <css, JS, images> # CSS files, Javascripts files
| | |-- scripts.html # Scripts common to all pages | |
| | | |-- templates/ # Templates used to render pages
| |-- layouts/ # Master pages | | |-- includes/ # HTML chunks and components
| | |-- base-fullscreen.html # Used by Authentication pages | | | |-- navigation.html # Top menu component
| | |-- base.html # Used by common pages | | | |-- sidebar.html # Sidebar component
| | | | | |-- footer.html # App Footer
| |-- accounts/ # Authentication pages | | | |-- scripts.html # Scripts common to all pages
| |-- login.html # Login page | | |
| |-- register.html # Registration page | | |-- layouts/ # Master pages
| | | |-- base-fullscreen.html # Used by Authentication pages
| | | |-- base.html # Used by common pages
| | |
| | |-- accounts/ # Authentication pages
| | | |-- login.html # Login page
| | | |-- register.html # Register page
| | |
| | |-- home/ # UI Kit Pages
| | |-- index.html # Index page
| | |-- 404-page.html # 404 page
| | |-- *.html # All other pages
| |
| config.py # Set up the app
| __init__.py # Initialize the app
| |
|-- requirements.txt # Development modules - SQLite storage |-- requirements.txt # Development modules - SQLite storage
|-- requirements-mysql.txt # Production modules - Mysql DMBS |-- requirements-mysql.txt # Production modules - Mysql DMBS
|-- requirements-pqsql.txt # Production modules - PostgreSql DMBS |-- requirements-pqsql.txt # Production modules - PostgreSql DMBS
| |
|-- .env # Inject Configuration via Environment |-- Dockerfile # Deployment
|-- config.py # Set up the app |-- docker-compose.yml # Deployment
|-- run.py # Start the app - WSGI gateway |-- gunicorn-cfg.py # Deployment
|-- nginx # Deployment
| |-- appseed-app.conf # Deployment
|
|-- .env # Inject Configuration via Environment
|-- run.py # Start the app - WSGI gateway
| |
|-- ************************************************************************ |-- ************************************************************************
``` ```
<br /> <br />
> The bootstrap flow
- `run.py` loads the `.env` file
- Initialize the app using the specified profile: *Debug* or *Production*
- If env.DEBUG is set to *True* the SQLite storage is used
- If env.DEBUG is set to *False* the specified DB driver is used (MySql, PostgreSQL)
- Call the app factory method `create_app` defined in app/__init__.py
- Redirect the guest users to Login page
- Unlock the pages served by *home* blueprint for authenticated users
<br />
## Recompile CSS
To recompile SCSS files, follow this setup:
<br />
**Step #1** - Install tools
- [NodeJS](https://nodejs.org/en/) 12.x or higher
- [Gulp](https://gulpjs.com/) - globally
- `npm install -g gulp-cli`
- [Yarn](https://yarnpkg.com/) (optional)
<br />
**Step #2** - Change the working directory to `assets` folder
```bash
$ cd apps/static/assets
```
<br />
**Step #3** - Install modules (this will create a classic `node_modules` directory)
```bash
$ npm install
// OR
$ yarn
```
<br />
**Step #4** - Edit & Recompile SCSS files
```bash
$ gulp scss
```
The generated file is saved in `static/assets/css` directory.
<br />
## Browser Support ## Browser Support
At present, we officially aim to support the last two versions of the following browsers: At present, we officially aim to support the last two versions of the following browsers:

2
package.json
View File

@ -1,7 +1,7 @@
{ {
"name": "black-dashboard-flask", "name": "black-dashboard-flask",
"mastertemplate": "boilerplate-code-flask-dashboard", "mastertemplate": "boilerplate-code-flask-dashboard",
"version": "1.0.3", "version": "1.0.4",
"description": "Template project - Flask Boilerplate Code ", "description": "Template project - Flask Boilerplate Code ",
"scripts": {}, "scripts": {},
"repository": { "repository": {