README.md

laravel-dashboard-plausible-tile

A simple tile for showing Plausible analytics within for your dashboard.

This tile can be used on the Laravel Dashboard.

Installation

You can install the package via composer:

composer require kilobyteno/laravel-dashboard-plausible-tile

Publish config for laravel-plausible:

php artisan vendor:publish --tag="plausible-config"

Open config/plausible.php and add your Plausible API Key.

Then add this to config/dashboard.php under the tile key:

'plausible' => [
    'refresh_interval_in_seconds' => 60,
    'domains' => [
        'kilobyte.no',
        'example.com',
    ],
],

Under "schedule" in kernel.php add:

$schedule->command(FetchDataFromPlausibleCommand::class)->everyMinute();

Usage

In your dashboard view you use the livewire:plausible-tile component.

<x-dashboard>
    <livewire:plausible-tile position="a1:a8" />
</x-dashboard>

Customizing the view

If you want to customize the view used to render this tile, run this command:

php artisan vendor:publish --provider="Kilobyteno\PlausibleTile\PlausibleTileServiceProvider" --tag="dashboard-plausible-tile-views"

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

• Kilobyte AS
• All Contributors

License

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