Skip to content

Scan your entire site with Google Lighthouse in 2 minutes (on average). Open source, fully configurable with minimal setup.

License

Notifications You must be signed in to change notification settings

harlan-zw/unlighthouse

Repository files navigation

unlighthouse - Delightfully navigate your sites performance, accessibility and seo.

NPM version NPM Downloads Docs & Demos
GitHub stars


Unlighthouse is an entire site audit tool with a modern UI for scanning live and development sites using Google Lighthouse


Status: Private Beta πŸŽ‰
Made possible by my Sponsor Program πŸ’–

Why Unlighthouse?

To scratch my own itch.

There was no open-source solutions to elegantly scan your entire site with lighthouse and interpret the data, so I made one.

While creating it I explored some ideas on how it can be made to scan larger sites, sites without sitemaps and how to extract SEO data.

The end product is a tool which should provide values for most sites out of the box with minimal configuration.

Features

⚑️ Fast

Take advantage of your CPU with multi-threaded workers powered by puppeteer-cluster and use opportunistic throttling and categories for lightning quick scans.

🌈 Modern UI

View your sites' health as a whole with the Unlighthouse client built with Vite. Easily see, search and sort your pages, re-scan individual pages and more.

Pre-packed with fast, configurable URL discovery using sitemap.xml or internal link parsing.

οΈπŸ€“ Intelligent URL Sampling

Scanning a website with thousands of pages? No problem.

Point Unlighthouse to the local project for the scan and any dynamic routes will be sampled based on your page files.

🍬️ SEO Goodies

View all of your pages titles, share images, meta descriptions, see how many internal and external links you have.

πŸ§‘β€πŸ’» Integrated Development

Finding issues with your site is one thing, fixing them is another. Unlighthouse comes packed with local development plugins for most popular frameworks.

See which file belongs to a URL, fix your issue, unlighthouse will automatically re-audit the page!

πŸ€– CI Ready

Set a budget for all each category, scan all pages, know if any of the pages breaks the budget. Easy.

Use the CI to upload your sites reports and access them all at any time, like inspect.unlighthouse.dev.

πŸ›  Hackable

Unlighthouse was built to modify, with isolate packages, robust API and a generous hook system. You can even modify the columns in the client!

Getting Started

Unlighthouse - Live Sites

Ensure you're using Node.js >=14 and run the following command:

npm add -G unlighthouse
unlighthouse --site https://unlighthouse.dev/

Unlighthouse - Development Sites

See integrations on how you can run Unlighthouse in your development environment.

Try it Online ⚑️

unlighthouse.dev/new

Sponsors

This project is made possible by all the sponsors supporting my work:

License

MIT License Β© 2022 Harlan Wilton