README

PageSpeed with History is a PHP package that provides a convenient way to track and analyze the performance of web pages over time. It allows developers to monitor page speed metrics, identify performance bottlenecks, and optimize their websites for better user experience.

Installation

You can install the package via composer:

composer require grezlikowski/page-speed

Run migrations:

php artisan migrate

Add your Google PageSpeed Insights API key to .env:

GOOGLE_PAGESPEED_API_KEY=your-api-key-here

Publishing

Migrations run automatically without publishing. Config works out of the box thanks to mergeConfigFrom. You can optionally publish assets to customize them:

Config:

php artisan vendor:publish --tag="page-speed-config"

Views:

php artisan vendor:publish --tag="page-speed-views"

Usage

Visit /page-speed in your browser. By default, the panel is accessible to everyone.

Authorization

You can restrict access to the panel using a Laravel Gate. Define a viewPageSpeed gate in your AppServiceProvider:

use Illuminate\Support\Facades\Gate;

public function boot(): void
{
    Gate::define('viewPageSpeed', function ($user) {
        return $user->is_admin;
    });
}

If the viewPageSpeed gate is not defined, the panel is open to all users.

You can also change the gate name in the config:

// config/page-speed.php
'gate' => 'myCustomGate',

Alternatively, use a custom callback via PageSpeedPanel::auth() in your AppServiceProvider:

use Grezlikowski\PageSpeed\PageSpeedPanel;

public function boot(): void
{
    PageSpeedPanel::auth(function ($request) {
        return $request->user()?->hasRole('administrator');
    });
}

When a custom callback is registered via PageSpeedPanel::auth(), it takes priority over the gate.

Configuration

You can customize the panel path, middleware, and other settings in config/page-speed.php:

return [
    'api_key' => env('GOOGLE_PAGESPEED_API_KEY', ''),
    'path' => env('PAGESPEED_PATH', 'page-speed'),
    'middleware' => ['web'],
    'default_strategy' => 'mobile',
    'history_limit' => 50,
    'timeout' => 60,
    'gate' => 'viewPageSpeed',
    'enabled' => env('PAGESPEED_ENABLED', true),
];

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Łukasz Gręźlikowski
• All Contributors

This package was created using the Spatie Package Skeleton.

License

The MIT License (MIT). Please see License File for more information.