Sign inSign up

oudhami/web-experience-audit-toolkit

By oudhami

•Updated about 1 month ago

Image
0

73

oudhami/web-experience-audit-toolkit repository overview

⁠Web Experience Audit Toolkit 🔎

Docker Pulls Image Size License: MIT Privacy Engine

A dependency-free, privacy-first, client-side HTML auditing tool packaged as an ultra-lightweight Docker container (< 25 MB). Paste any HTML source code and get an instant structured report on accessibility, document structure, form usability, and performance signals — processed entirely inside the browser with zero data sent to any server.

Maintained by AzkiWeb⁠ — Web Engineering & Digital Product Design Studio.


⁠🚀 Quick Start

docker run -d -p 8080:80 --name web-audit oudhami/web-experience-audit-toolkit:latest

Open your browser at http://localhost:8080⁠ and start auditing.


⁠🐙 Docker Compose

services:
  web-audit:
    image: oudhami/web-experience-audit-toolkit:latest
    container_name: web-experience-audit-toolkit
    ports:
      - "8080:80"
    restart: unless-stopped
docker compose up -d

⁠✅ What It Audits

⁠🔵 Accessibility (a11y)
  • Missing lang attribute on <html>
  • Images without alt attribute
  • Links and buttons without accessible names (aria-label, aria-labelledby, meaningful text content)
  • Form controls without associated <label> (for/id pairing, wrapping label, or aria-label)
⁠🟢 Document Structure
  • Missing <meta name="viewport"> for responsive mobile rendering
  • Missing or empty <title>
  • Missing <h1> heading
  • Heading level jumps (e.g. H2 → H4)
  • Missing semantic <main> landmark
⁠🟡 Performance Signals
  • Classic parser-blocking <script> tags without defer, async, or type="module"
  • Inline <style> blocks
  • External third-party resource dependencies
⁠🟣 Form & UX
  • Unlabeled <input>, <select>, and <textarea> elements
  • Buttons with no accessible name (icon-only with no text or ARIA)

⁠📊 How Scoring Works

StepAction
1. ParseHTML is converted to a DOM tree via DOMParser
2. InspectRules are applied to each element in the document
3. ClassifyEach finding gets a severity: high, medium, or low
4. ScoreEach category score and overall average are calculated

Four scores are produced — Accessibility, Structure, Performance, Form & UX — and combined into a single overall score (0–100).

Scores are heuristic summaries of the implemented rules, not WCAG compliance certificates or Lighthouse replacements.


⁠🔒 100% Privacy — Local-First by Design

All parsing runs inside the user's browser using the native DOMParser API. There is:

  • ✅ No backend server
  • ✅ No API calls
  • ✅ No analytics or telemetry
  • ✅ No source code upload

Safe for auditing private dashboards, unreleased products, internal admin panels, and confidential staging environments.


⁠🛠️ Technical Specs

PropertyValue
Base Imagenginx:1.27-alpine
Final Image Size< 25 MB
Platformslinux/amd64, linux/arm64
JavaScriptVanilla JS, zero dependencies
CompressionGzip enabled
Security HeadersX-Content-Type-Options, X-Frame-Options, Referrer-Policy


⁠📄 License

MIT — Free to use, modify, and distribute.

Maintained by AzkiWeb⁠.

Tag summary

Content type

Image

Digest

sha256:8da24868d…

Size

20 MB

Last updated

about 1 month ago

docker pull oudhami/web-experience-audit-toolkit