solitweb/laravel-dashboard-soundtrack-tile

A Soundtrack Your Brand tile for Laravel Dashboard

1.0.1 2021-09-14 07:34 UTC

This package is auto-updated.

Last update: 2024-11-14 15:22:01 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

This tile displays "now playing" infomation from Soundtrack Your Brand.

This tile can be used on the Laravel Dashboard.

Installation

You can install the package via composer:

composer require solitweb/laravel-dashboard-soundtrack-tile

In the dashboard config file, you must add this configuration in the tiles key.

// in config/dashboard.php

return [
    // ...
    'tiles' => [
        'soundtrack' => [
            'email' => env('SOUNDTRACK_EMAIL'),
            'password' => env('SOUNDTRACK_PASSWORD'),
            'sound_zone' => env('SOUNDTRACK_SOUND_ZONE'),
            'refresh_interval_in_seconds' => 60,
        ],
    ],
];

In app\Console\Kernel.php you should schedule the Solitweb\SoundtrackTile\FetchDataFromApiCommand to run every minute.

// in app/console/Kernel.php

protected function schedule(Schedule $schedule)
{
    // ...
    $schedule->command(\Solitweb\SoundtrackTile\FetchDataFromApiCommand::class)->everyMinute();
}

Usage

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

<x-dashboard>
    <livewire:soundtrack-tile position="a1" />
</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="Solitweb\SoundtrackTile\SoundtrackTileServiceProvider" --tag="dashboard-soundtrack-tile-views"

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 stijn@solitweb.be instead of using the issue tracker.

Credits

License

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