Prepared for publishing to GitHub Pages and changed SW absolute paths into relative ones.

Author: kottochii

.github/workflows/static.yml

@@ -0,0 +1,43 @@
+# 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: ["main"]
+
+  # 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+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
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,13 +1,16 @@
 # Motor Control Client
 
-This client is to be used with the [MotorControlServer](https://github.com/kottochii/MotorControlServer). It allows the user to sign in by pin to a running server. 
+This client is to be used with the [MotorControlServer](https://github.com/kottochii/MotorControlServer). It allows the user to sign in by pin to a running server.
 
 ## PWA
 This is a PWA-ready app, which means that when root is run on the server that meets [minimum requirements](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#https_localhost_or_loopback_are_required), the user will be able to install the app in their browser.
 
+### GitHub Pages
+This repository is published to https://kottochii.github.io/MotorControlClient/
+
 ## Setup (input the server data)
 When the app is opened the first time, it cannot function without a setup process. This involves:
-1. going to settings by clicking a respective icon in top-right corner.
+1. Going to settings by clicking a respective icon in top-right corner.
 2. Adding hostname with port (e.g. `localhost:5555`) of the server on the first line
 3. Selecting a radio `HTTP` or `HTTPS`
 4. Setting `App ID` and `App Hash` as per database.

app_offline_sw.js

@@ -1,21 +1,21 @@
 
 const CACHE_VERSION = 'motor-control-client-v1';
 const URLS_TO_CACHE = [
-  '/',
-  '/css/main.css',
-  '/img/motor_icon_192.png',
-  '/img/motor_icon_512.png',
-  '/img/settings_icon.svg',
-  '/js/api_logic.js',
-  '/js/jquery-3.7.1.min.js',
-  '/js/keypad_logic.js',
-  '/js/settings.js',
-  '/js/signed_in_worker.js',
-  '/js/signin_state.js',
-  '/js/state_manager.js',
-  '/app_offline_sw.js',
-  '/index.html',
-  '/manifest.webmanifest'
+  './',
+  './css/main.css',
+  './img/motor_icon_192.png',
+  './img/motor_icon_512.png',
+  './img/settings_icon.svg',
+  './js/api_logic.js',
+  './js/jquery-3.7.1.min.js',
+  './js/keypad_logic.js',
+  './js/settings.js',
+  './js/signed_in_worker.js',
+  './js/signin_state.js',
+  './js/state_manager.js',
+  './app_offline_sw.js',
+  './index.html',
+  './manifest.webmanifest'
 ];
 
 self.addEventListener('install', event => {

js/settings.js

@@ -1,6 +1,6 @@
 if ('serviceWorker' in navigator) {
   window.addEventListener('load', () => {
-    navigator.serviceWorker.register('/app_offline_sw.js')
+    navigator.serviceWorker.register('./app_offline_sw.js')
       .then(registration => console.log('SW registered', registration))
       .catch(err => console.log('SW registration failed: ', err));
   });

manifest.webmanifest

@@ -1,8 +1,8 @@
 {
   "short_name": "Motor Controller",
   "name": "Motor Controller Client",
-  "start_url": "/",
-  "scope": "/",
+  "start_url": "./",
+  "scope": "./",
   "display": "standalone",
   "theme_color": "#000000",
   "background_color": "#ffffff",