kreas/lighthouse-api repository overview

⁠Lighthouse API

Lighthouse API is a containerized service for running Lighthouse audits on web pages using Google Chrome. It provides a simple API endpoint to perform Lighthouse audits on any given URL.

⁠Features

• Runs Lighthouse audits via a RESTful API
• Containerized for easy deployment and scaling
• Built with Node.js 20 and Hono framework
• Uses the latest version of Lighthouse
• Configurable through environment variables

⁠Quick Start

To run the Lighthouse API service:

docker run -p 4128:4128 huntgathercreate/lighthouse-api

The service will be available at http://localhost:4128.

⁠API Usage

To perform a Lighthouse audit:

curl "http://localhost:4128/audit?url=https://example.com"

This will return a JSON object containing the Lighthouse audit report.

⁠Environment Variables

• NODE_ENV: Set to production for production use
• PORT: The port on which the service runs (default: 4128)

⁠Docker Compose

For more advanced setups, you can use Docker Compose. Here's a sample docker-compose.yml:

version: '3'
services:
  lighthouse-service:
    image: kreas/lighthouse-api
    ports:
      - "4128:4128"
    environment:
      - NODE_ENV=production

⁠GitHub Repository

For more information, contributions, or issues, please visit our GitHub repository: https://github.com/Hunt-Gather-Create/lighthouse-api⁠

⁠License

This project is licensed under the MIT License.