Skip to content

README.md

Latest commit

 

History

History
159 lines (105 loc) · 4.29 KB

README.md

File metadata and controls

159 lines (105 loc) · 4.29 KB
Raw

Site Auditor

MIT Runtime Stack Dependencies Mode

Audit the page.

See what needs fixing.

site-auditor checks websites for accessibility, SEO, security headers, performance, CSS quality, and JavaScript quality from a standalone local dashboard.

Live page · GitHub repo

  • Run a local Express auditor with an embedded glass dashboard.
  • Score six practical categories from one URL.
  • Export reports as JSON or CSV.
  • Keep the tool small: no frontend build step, no hosted service required.

Quick Start

git clone https://github.com/jenninexus/site-auditor.git
cd site-auditor
npm install
npm run dev

Open:

http://localhost:3847

On Windows:

start.bat

What It Checks

Category What It Checks
CSS Quality Fragmentation, naming consistency, framework conflicts, minification
JavaScript Duplicate scripts, fragmentation, inline bloat, minification
Accessibility WCAG 2.1 AA/AAA contrast in light and dark mode, color fix suggestions
SEO Title, meta description, headings, alt text, Open Graph, structured data
Security CSP, HSTS, X-Frame-Options, HTTPS, Content-Type-Options, Referrer-Policy
Performance Page weight, asset count, render-blocking, compression, lazy loading

API

POST /api/audit

{ "url": "https://example.com" }

Returns scores from 0-100 for all six categories, issues with severity/recommendations, and detailed reports.

GET /api/health

Server status, version, and uptime.

POST /api/export/csv

Export audit results as CSV.

POST /api/export/json

Export audit results as JSON.

Architecture

src/
├── server.ts              Express server ($SITE_AUDITOR_PORT, default 3847)
├── analyzers/
│   ├── audit-engine.ts    Orchestrator: fetches URL, runs analyzers, aggregates scores
│   ├── contrast.ts        WCAG contrast in light and dark mode
│   ├── seo.ts             SEO audit
│   ├── security.ts        Security headers
│   └── performance.ts     Performance analysis
├── dashboard.html         Single-file embedded dashboard
└── pitch.html             Marketing page served at /pitch

Design direction: dark glass dashboard with Syna design tokens, fast scanning, and practical remediation notes.

Scripts

npm run dev        # Start dev server with hot reload
npm run start      # Start production server
npm run check      # TypeScript type check
npm run lint       # ESLint (src/ + tests/)
npm run test       # Run tests
npm run build      # Compile TypeScript

Configuration

Env Variable Default Description
SITE_AUDITOR_PORT 3847 Server port

v2.0 Notes

Site Auditor v2 is a focused rewrite:

  • Before: Expo/React Native Web, Vercel-dependent, 68 dependencies, three styling systems.
  • After: Express + embedded HTML, standalone local dashboard, six total dependencies.

Core analysis algorithms were preserved with 150+ tests. SEO, security headers, and performance analyzers were added.

Contributing

Useful improvements:

  • New analyzers with clear recommendations.
  • Better report exports.
  • Accessibility fixes and contrast rule refinements.
  • More dashboard states for comparing multiple audits.

MIT — use, fork, customize

If this helps you ship a cleaner website:

Star this repo · Links · Patreon · Paypal

Published by Jenni at Monofinity Studio.