AbderrahmaneMouzoune/lighthouse-audit

Perform Lighthouse audits on websites using this simple Node.js project.

Lighthouse-audit

Maintainer: Abderrahmane Mouzoune

TABLE OF CONTENTS

• Overview
  • Prerequisites
  • Installation
  • Configuration
  • Usage
    • Run the audit
• Contribute
• Versions
• Acknowledgments
• Copyright

Overview

Perform Lighthouse audits on websites using this simple Node.js project.

This project utilizes Lighthouse to perform audits on websites and generate insightful reports. The audit results include metrics related to performance, accessibility, best practices, SEO, and Progressive Web App (PWA) standards.

Prerequisites

• Node.js (version 14 or higher)
• npm (included with Node.js)
• Google Chrome or Chromium

Installation

1. Clone the repository :

git clone https://github.com/AbderrahmaneMouzoune/lighthouse-audit
cd lighthouse-audit

2. Install dependencies :

npm install

Configuration

To choose all the website and url to audit you need to change the siteToAudit constant on src/config.ts, respect the architecture to have no problem

type WebSite = {
  name: string
  url: string
  pages: Page[]
}

type Page = {
  url: string
  name: string
}

Usage

Run the audit

Execute the following command to run the Lighthouse audit :

npm run start

This command will generate an Excel file with the audit results in the build folder -> To change the build folder you need to change export const folderForGeneratedResults = 'audit_results' on src/config.ts by the folder you want -> To change the excel file name you need to change export const filenameToGenerate = join(folderForGeneratedResults,'lighthouse_results.xlsx') on src/config.ts by the file name you want

Contribute

We welcome contributions for bug reports, issues, feature requests, feature implementations, and pull requests. Feel free to file a new issue 😃

For a complete guide on contributing to the plugin, see the Contribution Guidelines.

Versions

• If you want to see each release you can see that here

Acknowledgments

• Lighthouse is an open-source, automated tool designed to improve web page quality.
• ExcelJS is a powerful library used for reading, manipulating, and writing Excel files.
• Puppeteer is a Node library that offers a high-level API for controlling headless browsers.

Copyright

License MIT.

Thanks to :

• Mehdi HATTOU