Release v1.0.7

.dockerignore

@@ -0,0 +1,5 @@
+.git
+__pycache__
+*.pyc
+*.pyo
+*.pyd

.env

@@ -0,0 +1,11 @@
+DEBUG=False
+
+FLASK_APP=run.py
+FLASK_ENV=development
+
+DB_ENGINE=mysql
+DB_NAME=appseed_db
+DB_HOST=localhost
+DB_PORT=3306
+DB_USERNAME=appseed_db_usr
+DB_PASS=pass

.gitignore

@@ -0,0 +1,33 @@
+# byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# tests and coverage
+*.pytest_cache
+.coverage
+
+# database & logs
+*.db
+*.sqlite3
+*.log
+
+# venv
+env
+venv
+
+# other
+.DS_Store
+
+# sphinx docs 
+_build
+_static
+_templates
+
+# javascript
+package-lock.json
+.vscode/symbols.json
+
+apps/static/assets/node_modules
+apps/static/assets/yarn.lock
+apps/static/assets/.temp
+

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [1.0.7] 2022-05-20
+
+- Version built with [Black Dashboard Generator](https://appseed.us/generator/black-dashboard/)
+- Timestamp: `2022-05-20 15:37`
+
 ## [1.0.6] 2022-01-16
 ### Improvements
 

Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.9
+
+COPY . .
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# install python dependencies
+RUN pip install --upgrade pip
+RUN pip install --no-cache-dir -r requirements.txt
+
+# gunicorn
+CMD ["gunicorn", "--config", "gunicorn-cfg.py", "run:app"]

README.md

@@ -0,0 +1,257 @@
+# Flask [Black Dashboard](https://appseed.us/generator/black-dashboard/)
+
+Open-source **Flask Dashboard** generated by `AppSeed` op top of a modern `Bootstrap` design. Designed for those who like bold elements and beautiful websites, **[Black Dashboard](https://appseed.us/generator/black-dashboard/)** is ready to help you create stunning websites and webapps. **Black Dashboard** is built with over 50 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
+
+<br />
+
+> Context:
+
+- Built with [Black Dashboard Generator](https://appseed.us/generator/black-dashboard/)
+- Timestamp: `2022-05-20 13:32`
+- Build ID: `fa2fcff5-2226-4e87-9700-21ef7b1b515d`
+- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
+
+<br />
+
+> Features
+
+- `Up-to-date dependencies`
+- Database: `MySql`, `SQLite`
+- `DB Tools`: SQLAlchemy ORM, Flask-Migrate (schema migrations)
+- Session-Based authentication (via **flask_login**), Forms validation
+
+<br />
+
+![Black Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/169471556-144ea706-0965-4f7d-8493-da9570085367.png)
+
+<br />
+
+
+## ✨ Start the app in Docker
+
+> **Step 1** - Download the code from the GH repository (using `GIT`) 
+
+```bash
+$ # Get the code
+$ git clone https://github.com/app-generator/flask-black-dashboard.git
+$ cd flask-black-dashboard
+```
+
+> **Step 2** - Edit `.env` and set `DEBUG=True`. This will activate the `SQLite` persistance. 
+
+```txt
+DEBUG=True
+```
+
+<br />
+
+> **Step 3** - Start the APP in `Docker`
+
+```bash
+$ docker-compose up --build 
+```
+
+Visit `http://localhost:85` in your browser. The app should be up & running.
+
+<br />
+
+## ✨ Set up the MySql Database
+
+**Note:** Make sure your Mysql server is properly installed and accessible. 
+
+> **Step 1** - Create the MySql Database to be used by the app
+
+- `Create a new MySql` database
+- `Create a new user` and assign full privilegies (read/write)
+
+<br />
+
+> **Step 2** - Edit the `.env` to match your MySql DB credentials. Make sure `DB_ENGINE` is set to `mysql`.
+
+- `DB_ENGINE`: `mysql` 
+- `DB_NAME`: default value = `appseed_db`
+- `DB_HOST`: default value = `localhost`
+- `DB_PORT`: default value = `3306`
+- `DB_USERNAME`: default value = `appseed_db_usr`
+- `DB_PASS`: default value = `pass`
+
+<br />
+
+Here is a sample:  
+
+```txt
+# .env sample
+
+DEBUG=False                 # False enables the MySql Persistence
+
+DB_ENGINE=mysql             # Database Driver
+DB_NAME=appseed_db          # Database Name
+DB_USERNAME=appseed_db_usr  # Database User
+DB_PASS=<STRONG_PASS>       # Password 
+DB_HOST=localhost           # Database HOST, default is localhost 
+DB_PORT=3306                # MySql port, default = 3306 
+```
+
+<br />
+
+## ✨ How to use it
+
+> Download the code 
+
+```bash
+$ # Get the code
+$ git clone https://github.com/app-generator/flask-black-dashboard.git
+$ cd flask-black-dashboard
+```
+
+<br />
+
+### 👉 Set Up for `Unix`, `MacOS` 
+
+> Install modules via `VENV`  
+
+```bash
+$ virtualenv env
+$ source env/bin/activate
+$ pip3 install -r requirements.txt
+```
+
+<br />
+
+> Set Up Flask Environment
+
+```bash
+$ export FLASK_APP=run.py
+$ export FLASK_ENV=development
+```
+
+<br />
+
+> Start the app
+
+```bash
+$ flask run
+```
+
+At this point, the app runs at `http://127.0.0.1:5000/`. 
+
+<br />
+
+### 👉 Set Up for `Windows` 
+
+> Install modules via `VENV` (windows) 
+
+```
+$ virtualenv env
+$ .\env\Scripts\activate
+$ pip3 install -r requirements.txt
+```
+
+<br />
+
+> Set Up Flask Environment
+
+```bash
+$ # CMD 
+$ set FLASK_APP=run.py
+$ set FLASK_ENV=development
+$
+$ # Powershell
+$ $env:FLASK_APP = ".\run.py"
+$ $env:FLASK_ENV = "development"
+```
+
+<br />
+
+> Start the app
+
+```bash
+$ flask run
+```
+
+At this point, the app runs at `http://127.0.0.1:5000/`. 
+
+<br />
+
+### 👉 Create Users
+
+By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: 
+
+- Start the app via `flask run`
+- Access the `registration` page and create a new user:
+  - `http://127.0.0.1:5000/register`
+- Access the `sign in` page and authenticate
+  - `http://127.0.0.1:5000/login`
+
+<br />
+
+## ✨ Code-base structure
+
+The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
+
+```bash
+< PROJECT ROOT >
+   |
+   |-- apps/
+   |    |
+   |    |-- home/                           # A simple app that serve HTML files
+   |    |    |-- routes.py                  # Define app routes
+   |    |
+   |    |-- authentication/                 # Handles auth routes (login and register)
+   |    |    |-- routes.py                  # Define authentication routes  
+   |    |    |-- models.py                  # Defines models  
+   |    |    |-- forms.py                   # Define auth forms (login and register) 
+   |    |
+   |    |-- static/
+   |    |    |-- <css, JS, images>          # CSS files, Javascripts files
+   |    |
+   |    |-- templates/                      # Templates used to render pages
+   |    |    |-- includes/                  # HTML chunks and components
+   |    |    |    |-- navigation.html       # Top menu component
+   |    |    |    |-- sidebar.html          # Sidebar component
+   |    |    |    |-- footer.html           # App Footer
+   |    |    |    |-- scripts.html          # Scripts common to all pages
+   |    |    |
+   |    |    |-- 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                     # App Dependencies
+   |
+   |-- .env                                 # Inject Configuration via Environment
+   |-- run.py                               # Start the app - WSGI gateway
+   |
+   |-- ************************************************************************
+```
+
+<br />
+
+## ✨ PRO Version
+
+> For more components, pages and priority on support, feel free to take a look at this amazing starter:
+
+Black Dashboard is a premium Bootstrap Design now available for download in Django. Made of hundred of elements, designed blocks, and fully coded pages, Black Dashboard PRO is ready to help you create stunning websites and web apps.
+
+- 👉 [Black Dashboard PRO Flask](https://appseed.us/product/black-dashboard-pro/flask/) - Product Page
+- 👉 [Black Dashboard PRO Flask](https://flask-black-dashboard-pro.appseed-srv1.com/) - LIVE Demo
+
+<br >
+
+![Black Dashboard PRO - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/169471630-e96cec9b-ef57-4c06-9b36-62b9bbf255f3.png)
+
+<br />
+
+---
+Flask [Black Dashboard](https://appseed.us/generator/black-dashboard/) - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

apps/__init__.py

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+"""
+Copyright (c) 2019 - present AppSeed.us
+"""
+
+from flask import Flask
+from flask_login import LoginManager
+from flask_sqlalchemy import SQLAlchemy
+from importlib import import_module
+
+
+db = SQLAlchemy()
+login_manager = LoginManager()
+
+
+def register_extensions(app):
+    db.init_app(app)
+    login_manager.init_app(app)
+
+
+def register_blueprints(app):
+    for module_name in ('authentication', 'home'):
+        module = import_module('apps.{}.routes'.format(module_name))
+        app.register_blueprint(module.blueprint)
+
+
+def configure_database(app):
+
+    @app.before_first_request
+    def initialize_database():
+        db.create_all()
+
+    @app.teardown_request
+    def shutdown_session(exception=None):
+        db.session.remove()
+
+
+def create_app(config):
+    app = Flask(__name__)
+    app.config.from_object(config)
+    register_extensions(app)
+    register_blueprints(app)
+    configure_database(app)
+    return app

apps/authentication/__init__.py

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+"""
+Copyright (c) 2019 - present AppSeed.us
+"""
+
+from flask import Blueprint
+
+blueprint = Blueprint(
+    'authentication_blueprint',
+    __name__,
+    url_prefix=''
+)