Refactor.

Author: toddbirchard

.env.example

@@ -0,0 +1,4 @@
+FLASK_ENV=development
+FLASK_APP=wsgi.py
+FLASK_DEBUG=True
+LESS_BIN=/usr/local/bin/lessc

Pipfile

@@ -4,14 +4,14 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-Lesscpy = "*"
-CSSMin = "*"
-JSMin = "*"
 
 [packages]
 Flask = "*"
 Flask-Assets = "*"
 Python-Dotenv = "*"
+Lesscpy = "*"
+CSSMin = "*"
+JSMin = "*"
 
 [requires]
 python_version = "3.8"

README.md

@@ -1,11 +1,11 @@
 # Flask-Assets Tutorial
 
-![Python](https://img.shields.io/badge/Python-v^3.8-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
-![Flask](https://img.shields.io/badge/Flask-v1.1.2-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Python](https://img.shields.io/badge/Python-v3.8-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
+![Flask](https://img.shields.io/badge/Flask-v1.1.1-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![Flask-Assets](https://img.shields.io/badge/Flask--Assets-v2.0-blue.svg?longCache=true&logo=flask&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c&logo=GitHub)
 [![GitHub Issues](https://img.shields.io/github/issues/hackersandslackers/flask-assets-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-assets-tutorial/issues)
-[![GitHub Stars](https://img.shields.io/github/stars/hackersandslackers/flask-assets-tutorial.svg?style=flat-square8&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-assets-tutorial/stargazers)
+[![GitHub Stars](https://img.shields.io/github/stars/hackersandslackers/flask-assets-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-assets-tutorial/stargazers)
 [![GitHub Forks](https://img.shields.io/github/forks/hackersandslackers/flask-assets-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-assets-tutorial/network)
 
 ![Flask Assets Tutorial](https://github.com/hackersandslackers/flask-assets-tutorial/blob/master/.github/[email protected]?raw=true)
@@ -34,10 +34,18 @@ $ pipenv shell
 $ pipenv update
 $ flask run
 ```
------
 
-**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.
------
+## Usage
+
+Replace the values in **.env.example** with your values and rename this file to **.env**:
 
-**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.
+* `FLASK_APP`: Entry point of your application (should be `wsgi.py`).
+* `FLASK_ENV`: The environment to run your app in (either `development` or `production`).
+* `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
+* `LESS_BIN`: Path to your local LESS installation via `which lessc`.
+
+*Remember never to commit secrets saved in .env files to Github.*
+
+-----
 
+**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.

application/assets.py

@@ -7,15 +7,20 @@
 
 
 class Config:
+    """Set Flask configuration from .env file."""
 
-    # General
+    # General Config
+    SECRET_KEY = environ.get('SECRET_KEY')
+    FLASK_APP = environ.get('FLASK_APP')
     FLASK_ENV = environ.get('FLASK_ENV')
-    FLASK_DEBUG = 'wsgi.py'
-    STATIC_FOLDER = 'static'
-    TEMPLATES_FOLDER = 'templates'
 
     # Flask-Assets
-    LESS_BIN = '/usr/local/bin/lessc'
-    ASSETS_DEBUG = False
-    ASSETS_AUTO_BUILD = True
+    LESS_BIN = environ.get('LESS_BIN')
+    ASSETS_DEBUG = True
+    LESS_RUN_IN_DEBUG = True
+
+    # Static Assets
+    STATIC_FOLDER = 'static'
+    TEMPLATES_FOLDER = 'templates'
+    COMPRESSOR_DEBUG = True
 

application/main/main_routes.py

@@ -1,10 +1,10 @@
-"""Initialize app."""
+"""Initialize Flask app."""
 from flask import Flask
 from flask_assets import Environment
 
 
 def create_app():
-    """Construct the core application."""
+    """Construct core Flask app."""
     app = Flask(__name__, instance_relative_config=False)
     app.config.from_object('config.Config')
     assets = Environment()
@@ -14,7 +14,7 @@ def create_app():
     assets.init_app(app)
 
     with app.app_context():
-        # Import parts of our application
+        # Import parts of our flask_assets_tutorial
         from .admin import admin_routes
         from .main import main_routes
         from .assets import compile_static_assets

config.py

@@ -7,13 +7,15 @@
     __name__,
     template_folder='templates',
     static_folder='static'
-)  # Blueprint Configuration
+)
 
 
 @admin_bp.route('/dashboard', methods=['GET'])
 def dashboard():
     """Admin dashboard route."""
-    return render_template('dashboard.jinja2',
-                           title='Admin Dashboard | Flask-Blueprint Tutorial',
-                           template='dashboard-static account',
-                           body="Account")
+    return render_template(
+        'dashboard.jinja2',
+        title='Admin Dashboard | Flask-Blueprint Tutorial',
+        template='dashboard-static account',
+        body="Account"
+    )

application/__init__.py renamed to flask_assets_tutorial/__init__.py

@@ -0,0 +1,34 @@
+"""Compile static assets."""
+from flask import current_app as app
+from flask_assets import Bundle
+
+
+def compile_static_assets(assets):
+    """Configure and build asset bundles."""
+    main_style_bundle = Bundle(
+        'src/less/*.less',
+        'main_bp/homepage.less',
+        filters='less,cssmin',
+        output='dist/css/landing.css',
+        extra={'rel': 'stylesheet/css'}
+    )  # Main Stylesheets Bundle
+    main_js_bundle = Bundle(
+        'src/js/main.js',
+        filters='jsmin',
+        output='dist/js/main.min.js'
+    )  # Main JavaScript Bundle
+    admin_style_bundle = Bundle(
+        'src/less/*.less',
+        'admin_bp/admin.less',
+        filters='less,cssmin',
+        output='dist/css/account.css',
+        extra={'rel': 'stylesheet/css'}
+    )  # Admin Stylesheets Bundle
+    assets.register('main_styles', main_style_bundle)
+    assets.register('main_js', main_js_bundle)
+    assets.register('admin_styles', admin_style_bundle)
+    if app.config['FLASK_ENV'] == 'development':  # Only rebuild bundles in development
+        main_style_bundle.build()
+        main_js_bundle.build()
+        admin_style_bundle.build()
+    return assets

application/admin/admin_routes.py renamed to flask_assets_tutorial/admin/admin_routes.py

@@ -0,0 +1,43 @@
+"""Routes for main pages."""
+from flask import Blueprint, render_template
+
+
+main_bp = Blueprint(
+    'main_bp',
+    __name__,
+    template_folder='templates',
+    static_folder='static'
+)
+
+
+@main_bp.route('/', methods=['GET'])
+def home():
+    """Homepage route."""
+    return render_template(
+        'index.jinja2',
+        title='Home | Flask-Blueprint Tutorial',
+        template='home-static main',
+        body="Home"
+    )
+
+
+@main_bp.route('/about', methods=['GET'])
+def about():
+    """About page route."""
+    return render_template(
+        'index.jinja2',
+        title='About | Flask-Blueprint Tutorial',
+        template='about-static main',
+        body="About"
+    )
+
+
+@main_bp.route('/etc', methods=['GET'])
+def etc():
+    """Etc page route."""
+    return render_template(
+        'index.jinja2',
+        title='Etc | Flask-Blueprint Tutorial',
+        template='etc-static main',
+        body="Etc"
+    )