Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
juanjol committed Apr 8, 2024
1 parent f5643b8 commit 3a52994
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
[![tests](https://github.com/Metadrop/ddev-lighthouse/actions/workflows/tests.yml/badge.svg)](https://github.com/Metadrop/ddev-lighthouse/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)

## ddev-lighthouse
* [What is DDEV Lighthouse Add-on?](#what-is-ddev-lighthouse-add-on)
* [Getting started](#getting-started)
* [Configuration](#configuration)
* [Running Tests](#running-tests)
* [Interpreting Results](#interpreting-results)

This is a ddev-addon for running performance tests using Lighthouse, an open-source automated tool for improving web page quality. It utilizes the `tests/functional/lighthouserc.js` configuration file for test setup and saves reports in the `reports/lighthouse` folder of your project.
## What is DDEV Lighthouse Add-on?

This is a [DDEV](https://ddev.readthedocs.io) addon for running performance tests using Lighthouse, an open-source automated tool for improving web page quality. It utilizes the `tests/functional/lighthouserc.js` configuration file for test setup and saves reports in the `reports/lighthouse` folder of your project.

This is optimized for [Aljibe projects](https://github.com/Metadrop/Aljibe/), but can be used in any DDEV project.

Lighthouse analyzes performance, accessibility, best practices, and more of your web pages, generating detailed reports to help you enhance your site's quality and performance.

## Getting Started

Install this addon by running the following command:

ddev get Metadrop/ddev-lighthouse
`ddev get Metadrop/ddev-lighthouse`

Once installed, make sure to restart your ddev project:

ddev restart
`ddev restart`

### Configuration

Expand All @@ -24,14 +32,14 @@ This addon uses the `tests/functional/lighthouserc.js` configuration file to cus

To execute Lighthouse tests, simply access your ddev environment and run the following command:

ddev lighthouse
`ddev lighthouse`

Lighthouse will generate detailed reports and save them in the `reports/lighthouse` folder of your project.

### Interpreting Results

Once Lighthouse reports are generated, you can review them to identify areas for improvement in performance, accessibility, and more of your website.

We hope this addon helps you enhance the quality and performance of your web project. If you have any questions or issues, feel free to reach out to us.

Happy optimization!

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

0 comments on commit 3a52994

Please sign in to comment.