lukeyouell/craft-gtmetrix

GTmetrix gives you insight on how well your entries load and provides actionable recommendations on how to optimise them.

, _(*1)

GTmetrix plugin for Craft CMS 3.x

GTmetrix gives you insight on how well your entries load and provides actionable recommendations on how to optimise them., _(*2)

, _(*3)

Requirements

This plugin requires Craft CMS 3.0.0 or later., _(*4)

Installation

To install the plugin, follow these instructions., _(*5)

1. Open your terminal and go to your Craft project:, _(*6)

   cd /path/to/project

2. Then tell Composer to load the plugin:, _(*7)

   composer require lukeyouell/craft-gtmetrix

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for GTmetrix., _(*8)

Configuring GTmetrix

Upon successful installation you will be required to supply valid credentials to successfully communicate with the GTmetrix API., _(*9)

A GTmetrix account is required, if you don't already have one click here to create one., _(*10)

Free & paid plans are available., _(*11)

Using GTmetrix

Once you have provided valid credentials you will be able to make GTmetrix test requests., _(*12)

Making a Request

• Click the "New test" button
• Select an entry, location, browser and connection type
• Set additional conditions such as HTTP authentication, cookies, AdBlock and resource whitelisting/blacklisting
• Submit the request

Test states

Once a test has been successfully submitted, there are five possible states:, _(*13)

1. Requested

The request is waiting for a response., _(*14)

2. Queued

The request has been accepted and placed in a queue., _(*15)

3. Started

Testing has been initiated., _(*16)

4. Error

There was a problem with the test, a description of the error will be provided., _(*17)

5. Completed

The test has been completed and is now available for you to view., _(*18)

GTmetrix Roadmap

Some things to do, and ideas for potential features:, _(*19)

• Ability to re-test entry
• Restrict abilities if API credentials are missing
• Delete records
• Make test resources available

Brought to you by Luke Youell, _(*20)