jonlynch/briefing-tile

A package to add briefings to the dashboard

v1.2 2022-12-31 14:47 UTC

Requires

• php: >=7.4
• spatie/laravel-dashboard: >=1.0 <3.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Jon Lynch

• laravel-dashboard
• jonlynch

README

A tile to display briefing information

This tile can be used on the Laravel Dashboard.

Installation

You can install the package via composer:

$ composer require jonlynch/briefing-tile

Usage

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

<x-dashboard>
    <livewire:briefing-tile position="a1:a12" />
</x-dashboard>

Add the config to the tiles sections of your config/dashboard.php

// in config/dashboard.php

return [
    // ...
    tiles => [
         'briefing' => [
            'url' => env('BRIEFING_URL'),
        ],
    ]

In app\Console\Kernel.php you should schedule the JonLynch\BriefingTile\Commands\FetchBriefingDataCommand to run every minute.

// in app\Console\Kernel.php

protected function schedule(Schedule $schedule)
{
    $schedule->command(\JonLynch\BriefingTile\Commands\FetchBriefingDataCommand::class)->everyMinute();

}

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

• Jon Lynch
• All Contributors

License

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