[2.0] Major project update

.github/workflows/deploy_pages.yml

@@ -0,0 +1,53 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - master
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+      - name: Install dependencies
+        run: |
+          npm install
+      - name: Build
+        run: |
+          npm run build
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload distribution directory
+          path: "dist"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/run_js_tests.yml

@@ -0,0 +1,26 @@
+name: Test custom JavaScript
+
+on:
+  pull_request:
+    branches:
+      - master
+      - devel
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Test code with Jest
+        run: npm run test

.github/workflows/run_selenium.yml

@@ -0,0 +1,36 @@
+name: Test distribution with Selenium
+
+on:
+  pull_request:
+    branches:
+      - master
+      - devel
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          npm install
+          pip install -r requirements.txt
+
+      - name: Build the dist
+        run: npm run build:dev
+
+      - name: Test distribution with Selenium
+        run: pytest

.github/workflows/test_webpack_builds.yml

@@ -0,0 +1,44 @@
+name: Check project bundle builds
+
+on:
+  pull_request:
+    branches:
+      - master
+      - devel
+
+jobs:
+  development:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build the distribution bundle
+        run: npm run build:dev
+
+  production:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build the distribution bundle
+        run: npm run build

.github/workflows/upload_to_release.yml

@@ -0,0 +1,85 @@
+name: Upload distribution to release
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  jest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Test code with Jest
+        run: npm run test
+
+  pytest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          npm install
+          pip install -r requirements.txt
+
+      - name: Build the dist
+        run: npm run build:dev
+
+      - name: Test distribution with Selenium
+        run: pytest
+
+  upload:
+    runs-on: ubuntu-latest
+    needs: [jest, pytest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup NodeJs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build the distribution
+        run: npm run build:dev
+
+      - name: Create dist archive
+        run: zip -r dist.zip ./dist
+
+      - name: Upload release asset
+        uses: actions/upload-release-asset@v1
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: ./dist.zip
+          asset_name: dist.zip
+          asset_content_type: application/zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -5,11 +5,22 @@
 # node modules
 /node_modules/
 
+# python virtual environment
+/.venv/
+/.env/
+/venv/
+/env/
+
+# python byte-compiled
+__pycache__
+
+# distribution bundles directories
+/dist/
+
 # bootstrap source may be required for autocomplite,
 # but they aren't part of current repository content
-/css/bootstrap-*.*
-/css/bootstrap.*
-/js/bootstrap.*
+bootstrap-*.*
+bootstrap.*
 
 # emacs caches and backup files
 \#*\#

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Python training course authors and contributors
+Copyright (c) 2024 Python training course authors and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,36 +1,56 @@
 DJANGO BLOG - BOOTSTRAP TEMPLATES
 =================================
 
+[![](https://github.com/edu-python-course/blog-bootstrap/actions/workflows/deploy_pages.yml/badge.svg)](https://edu-python-course.github.io/blog-bootstrap)
+![](https://github.com/edu-python-course/blog-bootstrap/actions/workflows/test_webpack_builds.yml/badge.svg)
+![](https://github.com/edu-python-course/blog-bootstrap/actions/workflows/run_selenium.yml/badge.svg)
+
 This repo contains Bootstrap5 templates for the main training project, and
 itself is a supporting subproject.
 
-[Live preview](https://edu-python-course.github.io/blog-bootstrap/)
+Getting started
+---------------
+
+For those who want to use the templates provided in this repository -
+the shortest way is to check the 
+[release page](https://github.com/edu-python-course/blog-bootstrap/releases).
+Starting from `ver2.0` each release has a **dist.zip** attached to it.
+There are partials for individual site parts within the archive. These are
+suitable for using with template processors (like Django templates or Jinja2).
+
+In case you want to adjust the sources before build:
+
+1. Clone the repo to your local machine
+2. Install project dependencies: `npm install`
+3. Build templates: `npm run build`
+   - to build the developer's version: `npm run build:dev` 
 
 Contents
 --------
 
-- [index.html](./index.html)
-  This is the main blog page. It contains a list of blog posts.
-  Each entity is a link to detailed blog post page.
-- [detail.html](./detail.html)
-  This is a detailed blog post page. It contains the full blog post's
-  content. Comments related to a single blog post are also present here.
-- [form.html](./form_article.html)
-  Blog post form (Creation and update).
-- [profile.html](./profile.html)
-  User's personal page. This page is supposed to be public for all.
-  In case current user visiting their own profile page, this page will
-  include forms to change user data or set a new password. All blog posts
-  authored by a certain user is listed here in the form, similar to main
-  page view.
-- [form_login.html](./form_login.html)
-  User login form.
-- [form_registration.html](./form_registration.html)
-  New user registration form.
-- [profile.html](./profile.html)
-  User profile page.
-- [about.html](./about.html)
-  About page (static content).
+### Production vs Development bundles
+
+Production bundle is aimed to be served via GitHub pages. It's main purpose is
+the site demonstration.
+
+The development bundle is for usage with other projects (Django, Flask etc.).
+
+Both production and development distributions bundle the JS code into a single
+file. The same is for CSS. The only difference is the output distribution
+structure.
+
+### Sources
+
+All the source are located within **src** directory.
+
+`index.js` file is the entry point for the `webpack`. All resources required
+by webpack are to be imported here.
+
+`scss` directory contains individual styles used by various templates.
+
+`js` directory contains custom JavaScript modules used within the project.
+
+`views` directory contains templates for the HTML pages.
 
 References
 ----------