Init

.flaskenv

@@ -1,20 +1,5 @@
-FLASK_APP=app.py
-FLASK_ENV=developement
-
-# Application secret key (cookie encryption)
-SECRET_KEY="this-is-a-secret-that-should-be-changed"
-
-# Application name
-APP_NAME="Flask Boilerplate"
-
-# SQLite database name (stored in the root directory)
-SQLITE_DB_NAME="app.db"
-
-# Enable maintenance mode (prevents requests to the application when set to True)
-MAINTENANCE_MODE=False
-
-# Email settings configuration
-MAIL_SERVER_HOST="127.0.0.1"
-MAIL_SERVER_PORT=1025
-MAIL_SERVER_USERNAME=""
-MAIL_SERVER_PASSWORD=""
+FLASK_APP = "app.py"
+SECRET_KEY = "this-is-a-secret-that-should-be-changed"
+APP_NAME = "Flask Boilerplate"
+SQLITE_DB_NAME = "app.db"
+MAINTENANCE_MODE = 'False'

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: flake8 Lint
+
+on: [push, pull_request]
+
+jobs:
+  flake8-lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v3
+      - name: Set up Python environment
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: flake8 Lint
+        uses: py-actions/flake8@v2

.gitignore

@@ -1,5 +1,5 @@
 # Byte-compiled / optimized / DLL files
-__pycache__/
+**/__pycache__/
 *.py[cod]
 *$py.class
 
@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.DS_Store

.vscode/extensions.json

@@ -0,0 +1,17 @@
+{
+    "recommendations": [
+      // linters and formatters
+      "dbaeumer.vscode-eslint",
+      "esbenp.prettier-vscode",
+      "stylelint.vscode-stylelint",
+      "ms-python.flake8",
+      "ms-python.black-formatter",
+      // python
+      "ms-python.python",
+      "ms-python.vscode-pylance",
+      // Jinja
+      "samuelcolvin.jinjahtml",
+      // misc
+      "jakearl.search-editor-apply-changes",
+    ]
+  }

CONTRIBUTING

@@ -0,0 +1,9 @@
+# Contributing to Flask Boilerplate
+
+If you have any suggestions or improvements, then feel free to open an issue or a pull request. I'll be happy to take a look at it!
+
+## Code style
+
+Please follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide when contributing to this project (or any other Python project, for that matter). In order to make your life easier when contributing, you can install [flake8](https://flake8.pycqa.org/en/latest/) and [black](https://black.readthedocs.io/en/stable/) and run `flake8` and `black .` before committing your changes. This will ensure that your code is formatted correctly and that it follows the PEP 8 style guide.
+
+For VSCode users, you will be prompted to install the recommended extensions when opening the project for the first time.

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>