Skip to content
This repository was archived by the owner on Sep 16, 2025. It is now read-only.

edmadrid/lighthouse-dashboard

Repository files navigation

Lighthouse Accessibility Dashboard Demo

Netlify Status

Requirements

  • Node js
  • Lighthouse CLI
  • Chrome browser

Setup

Install lighthouse

npm install -g lighthouse

Script permissions

chmod +x run-tests.sh
chmod +x cleanup-reports.sh
chmod +x generate-index.sh
chmod +x src/scripts/lighthouse-cli-script.sh 
chmod +x src/scripts/run-audit.sh

Usage

To test a site, add a JSON file with a list of urls to src/inputs/, then run:

./run-tests.sh [file1.json file2.json ...]

Examples:

# Test all JSON files in src/inputs/
./run-tests.sh

# Test specific sites (with or without file extension)
./run-tests.sh ac.json dante.json

# List available sites
./run-tests.sh --list

# Show help
./run-tests.sh --help

Each test will:

  • Test all pages in the specified JSON file(s)
  • Generate individual dashboards (e.g., dist/ac.html)
  • Update the central dashboard at dist/index.html

Project Structure

  • /src/inputs/ - JSON files which list pages to test for each site
  • /src/scripts/ - Build and processing scripts
  • /src/assets/ - Static assets (CSS, images) that get copied to /dist/
  • /dist/ - Generated HTML dashboards and copied assets

Local Development

For optional live development with CSS changes:

npm install        # Install browser-sync locally (optional)
npm run serve      # Start development server with live reload

The development server will:

  • Serve files from /dist/
  • Auto-reload when you edit CSS in /src/assets/styles.css
  • Watch for changes to HTML and JS files in /dist/

Additional Scripts

  • ./cleanup-reports.sh - Remove old lighthouse report files to save disk space
  • ./generate-index.sh - Manually regenerate the tabbed index and copy assets from existing dashboards

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published