https://github.com/electerious/ackee-lighthouse
Send Lighthouse reports to Ackee.
https://github.com/electerious/ackee-lighthouse
Last synced: 8 months ago
JSON representation
Send Lighthouse reports to Ackee.
- Host: GitHub
- URL: https://github.com/electerious/ackee-lighthouse
- Owner: electerious
- License: mit
- Created: 2021-01-13T16:33:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-08T13:33:20.000Z (over 1 year ago)
- Last Synced: 2025-05-15T13:43:57.323Z (about 1 year ago)
- Language: JavaScript
- Size: 706 KB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ackee-lighthouse
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CYKBESW577YWE)
A script that runs continuously thanks to GitHub Actions and sends [Lighthouse](https://developers.google.com/web/tools/lighthouse) reports the Ackee.
## 🤗 Usage
### 1. Install dependencies
ackee-lighthouse dependents on …
- [Node.js](https://nodejs.org/en/) (v18 or newer)
- [npm](https://www.npmjs.com)
- [Chrome](https://www.google.com/chrome/index.html)
Make sure to install and update all dependencies before you continue. The installation instructions for the individual dependencies can be found on the linked websites.
### 2. Create the configuration
Pull the project and configure ackee-lighthouse using environment variables or create a [`.env` file](https://www.npmjs.com/package/dotenv) in the root of the project to store all variables in one file.
Examples:
```
ACKEE_ENDPOINT=https://ackee.example.com/api
ACKEE_EVENT_ID=a26932b8-a088-4fc1-b723-c3ea5b9ba9e4
URL=https://a.example.com
```
```
ACKEE_ENDPOINT=https://ackee.example.com/api
ACKEE_EVENT_ID=a26932b8-a088-4fc1-b723-c3ea5b9ba9e4,6bad9a10-ed63-447b-b026-086b80da15d2
URL=https://a.example.com,https://b.example.com
AUDIT=speed-index.numericValue
```
### 3. Install ackee-lighthouse
Install all required dependencies.
```sh
npm install
```
### 4. Run ackee-lighthouse
ackee-lighthouse will create a Lighthouse report for every URL specified in the environment. The `AUDIT` option must be a [dot path](https://github.com/sindresorhus/dot-prop) that selects a single value from the Lighthouse report. It defaults to `speed-index.numericValue`, which will report the speed index as a numeric value (in milliseconds). ackee-lighthouse will send the selected value to the specified Ackee event.
Multiple URLs are handled so that the first URL uses the first event id, the second URL uses the second event id, and so on.
```sh
npm start
```
## Miscellaneous
### Donate
I am working hard on continuously developing and maintaining Ackee. Please consider making a donation to keep the project going strong and me motivated.
- [Become a GitHub sponsor](https://github.com/sponsors/electerious)
- [Donate via PayPal](https://paypal.me/electerious)
- [Buy me a coffee](https://www.buymeacoffee.com/electerious)
### Links
- [Follow Ackee on Twitter](https://twitter.com/getackee)
- [Vote for Ackee on ProductHunt](https://www.producthunt.com/posts/ackee)