feat: add github pages deployment

- add workflow to deploy ./web to github pages
- document that web assets are served as-is without build
- note backend requires manual deployment via waterworks-infra

Author: lidel

.github/workflows/deploy-pages.yml

@@ -0,0 +1,39 @@
+# Deploy to GitHub Pages
+# Deploys pre-built static files from web/ directory
+# No build step required - files are used as-is
+
+name: Deploy to GitHub Pages
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './web'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -39,12 +39,19 @@ Learn available variables via `./ipfs-check --help`
 
 ### Frontend
 
-There are web assets in `web` that interact with the Go HTTP server that can be deployed however you deploy web assets.
-Maybe just deploy it on IPFS and reference it with DNSLink.
+The web assets in `./web` directory are embedded directly into the Go binary and served as-is. No build step is required for deployment - the pre-built CSS and static files are already committed to the repository.
 
-For anything other than local testing you're going to want to have a proxy to give you HTTPS support on the Go server.
+The latest version from the `main` branch is automatically deployed to https://check.ipfs.network for convenience.
 
-At a minimum, the following files should be available from your web-server on prod: `web/index.html`, `web/tachyons.min.css`.
+If you need to modify the web interface styles:
+1. Make changes to `web/input.css`
+2. Run `npm ci` and `npm run build` in the `web` directory (see `web/README.md` for details)
+3. Commit the updated `web/output.css` file
+
+> [!IMPORTANT]
+> Breaking changes to the HTTP API or frontend MUST be avoided. The new `./web` should always work with old backend versions to ensure compatibility.
+
+For production deployments, you'll want a proxy for HTTPS support on the Go server.
 
 
 ## Running locally

web/README.md

@@ -0,0 +1,56 @@
+# ipfs-check Web Interface
+
+This directory contains the static web assets for ipfs-check.
+
+## Deployment
+
+`./web` is automatically deployed to https://check.ipfs.network via GitHub Pages.
+
+Backend updates require manual deployment via `ipshipyard/waterworks-infra` ([example](https://github.com/ipshipyard/waterworks-infra/pull/740)).
+
+## Architecture
+
+The files in this directory are embedded directly into the Go binary and served as-is. No build step is required for normal deployment since the compiled CSS (`output.css`) is already committed to the repository.
+
+## Development
+
+### Prerequisites
+
+- Node.js and npm (only needed for modifying styles)
+
+### Modifying Styles
+
+The project uses Tailwind CSS for styling. If you need to make style changes:
+
+1. Install dependencies (one-time setup):
+   ```bash
+   npm ci
+   ```
+
+2. For development with live CSS updates:
+   ```bash
+   npm run dev
+   ```
+   This watches `input.css` for changes and automatically rebuilds `output.css`
+
+3. For production build (minified CSS):
+   ```bash
+   npm run build
+   ```
+
+4. **Important**: After making style changes, commit the updated `output.css` file
+
+### Files
+
+- `index.html` - Main HTML file
+- `script.js` - JavaScript logic for the check interface
+- `input.css` - Source Tailwind CSS file (modify this for style changes)
+- `output.css` - Compiled CSS (auto-generated, but committed to git)
+- `favicon.ico` - Site favicon
+- `fonts/` - Custom fonts
+
+### Notes
+
+- The `output.css` file is intentionally committed to version control
+- This allows the Go binary to embed and serve the web interface without requiring a build step
+- Only run `npm ci` and `npm run build` if you're modifying the styles