Skip to content

Antonytm/Sitecore.Lighthouse

Repository files navigation

Sitecore.Lighthouse

Build status GitHub top language

Abstract:

Integration of Google Lighthouse with Sitecore

Requirements:

Sitecore 8+

Project is build following Helix principles, but you can use it in any Sitecore project.

How to install

  1. Download Sitecore update package: a) from Github releases if you want stable version; b) from AppVeyor if you want latest version
  2. Install it using update installation wizard /sitecore/admin/UpdateInstallationWizard.aspx
  3. You need to inherit your pages templates from "/sitecore/templates/Foundation/Lighthouse/Partial/_Lighthouse". It is required to provide ability for tool to save service information to page item. Inheritance

How to use

After installation of Sitecore update package, you will get new ribbon in Content Editor: Sitecore Ribbon Buttons on Ribbon allows you run, run for all pages and sites, view chart statistics, view latest report.

Run Google Lighthouse report for page(item)

Run

It will execute Google Lighthouse for current page and save results to Lighthouse section of item. Service data

After running it, you will be able to see latest report or chart for this page.

Run Google Lighthouse report for all pages(items)

Run all

It will start background process to run Google Lighthouse for all websites and pages that are inherited from "_Lighthouse" template. Be patient, it takes some time to finish it for all pages on your websites.

View chart that provides statistics of previous runs

Chart

You are able to see history of main parameters changes after running report preparation for selected item. Chart example

View latest report for page

Latest report

You are able to see latest report by clicking Latest button. Latest report example

If you want to find some previous report, you can find it on disc, where your Sitecore is installed in folder App_Data\Lighthouse\Reports.

View summarized website statistics

Your website summary of Google Lighthouse report is saved under /sitecore/system/Modules/Lighthouse in master database. You are able to navigate to website you are interested in and see chart statistics for it, items with worst performace, items with best performance and logs. If for some page tool was not able to gather data then path for these items and reason will be present in logs. Site summary