https://github.com/tyler36/ddev-lighthouse

https://github.com/tyler36/ddev-lighthouse

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/tyler36/ddev-lighthouse
• Owner: tyler36
• License: apache-2.0
• Created: 2023-09-15T00:58:27.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-21T08:36:55.000Z (7 months ago)
• Last Synced: 2024-03-21T10:29:00.397Z (6 months ago)
• Language: Shell
• Size: 64.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)

# ddev-lighthouse 

- [Introduction](#introduction)

- [Components of the repository](#components-of-the-repository)

- [Getting started](#getting-started)

- [TODO](#todo)

## Introduction

This addon adds the ability to run Lighthouse reports against DDEV websites.

It can be configured to:

- assert URLs achieve specific targets

- save/upload reports

## Components of the repository

- `install.yaml`: Describes how DDEV will install the addon.

- `docker-compose.lighthouse.yaml`: Dockerfile to configure the lighthouse service.

- `lighthouse/config.yaml`: Configuration file used by `lhci` command.

- `commands/lighthouse/lhci`: DDEV command that is run in the "lighthouse" container.

## Getting started

1. Install the DDEV lighthouse add-on:

   ```shell

   ddev get tyler36/ddev-lighthouse

   ddev restart

   ```

2. Use the following command to run reports:

    ```shell

    ddev lhci

    ```

## TODO

- [ ] TODO: Add meaningful tests

- [ ] TODO: Fix command

**Contributed and maintained by [@tyler36](https://github.com/tyler36)**