https://github.com/loggi/lighthouse-average-performance
Generating more reliable lighthouse performance reports by running 'em multiple times and averaging the reports.
https://github.com/loggi/lighthouse-average-performance
Last synced: 8 months ago
JSON representation
Generating more reliable lighthouse performance reports by running 'em multiple times and averaging the reports.
- Host: GitHub
- URL: https://github.com/loggi/lighthouse-average-performance
- Owner: loggi
- Created: 2020-05-18T18:37:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-01T18:42:33.000Z (over 4 years ago)
- Last Synced: 2025-04-07T03:02:18.261Z (9 months ago)
- Language: JavaScript
- Size: 606 KB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lighthouse Average Performance
Lighthouse is an amazing tool to audit your app for performance, accessibility,
progressive web apps, SEO and more. Overral, it works pretty well, but when it
comes to assessing the performance of an app, there is an inherent variability
factor we should expect.
On its [_Lighthouse Metric Variability and
Accuracy_](https://docs.google.com/document/d/1BqtL-nG53rxWOI5RO0pItSRPowZVnYJ_gBEQCJ5EeUE/edit#),
the Lighthouse team describes this problem in more depth, explaining the
sources, the impact and how can it be mitigated.
This repository intends to mitigate the variability factor by consecutively
running the lighthouse performance audit n-times and averaging the results on
the created reports.
## How to use it
The project consists of two Node JS scripts (`generate-reports.js` and
`parse-reports.js`). To use them, you need Node 10+. The `generate-reports` will
run the lighthouse script _n-times_ and put the reports on a directory. The
`parse-reports` will read the reports generated by the former script on a
certain directory and generate the average performance metrics.
At the top of each script, there are variables you should customize to use them.
To run the scripts, you can do:
```sh
chmod +x generate-reports.js # give the file permission to be executed
chmod +x parse-reports.js
APP_URL="my-custom-url" ./generate-reports.js
APP_URL="my-custom-url" ./parse-reports.js
```
## Useful Links
- [Lighthouse Report Viewer](https://googlechrome.github.io/lighthouse/viewer/),
drop a json report and see it in a more human-readable format.
- [Lighthouse Metric Variability and
Accuracy](https://docs.google.com/document/d/1BqtL-nG53rxWOI5RO0pItSRPowZVnYJ_gBEQCJ5EeUE/edit?usp=sharing)
- [The Magic of Running Multiple Lighthouse Performance Tests on
macOS](https://medium.com/@iamasamanthaa/the-magic-of-running-multiple-lighthouse-performance-tests-on-macos-4d22ae56621c),
the first script was based on this article.