🚨 This is an experimental project primarily used for internal projects. We likely cannot provide much support over GitHub issues, though the code is available for anyone to read or study. If you would like a more robust monitoring solution we encourage you to take a look at Lighthouse CI.

Lighthouse Keeper

Lighthouse keeper is a backend for providing historical Lighthouse results for an URL.

There are several bits:

• Runs the Lighthouse API against a URL and stores reports over time (Firestore). Provides querying capabilities.
• The latest (full) report for the URL is stored (Google Cloud Storage).
• The server itself is Google App Engine (NodeJS). Cron jobs schedule tasks to update scores for each URL in the system, calculate median scores for each category, etc.

Development

1. Install it:

npm ci

2. Decrypt the service account and memcache JSON files:

npm run decrypt

You will be prompted to for a passphrase to decrypt serviceAccount.json.enc and memcacheCredentials.json.enc. These files are required for the backend to communicate with Firestore and the Redis memcache service. The password can be found in Google's shared password tool.

3. Run the web server:

npm run start

4. Build it

To build the CSS/JS bundles, run of npm run build:js, npm run build:css, or the single command:

npm run build

There are also watch tasks if you want to iterate on the files while the server is running:

npm run watch:css
npm run watch:js