solitweb/laravel-dashboard-weather-forecast-tile

A weather forecast tile for the Laravel Dashboard

1.0.2 2022-07-13 07:09 UTC

This package is auto-updated.

Last update: 2024-10-13 12:15:22 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

This tile displays a weather forecast.

This tile can be used on the Laravel Dashboard.

Installation

You can install the package via composer:

composer require solitweb/laravel-dashboard-weather-forecast-tile

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

// in config/dashboard.php

return [
    // ...
    'tiles' => [
        'weather_forecast' => [
            'open_weather_map_key' => env('OPEN_WEATHER_MAP_KEY'),
            'open_weather_map_city' => 'Antwerp',
            'units' => 'metric', // 'metric' or 'imperial' (metric is default)
            'locale' => 'en_US',
        ],
    ],
];

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

// in app/console/Kernel.php

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

Usage

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

<x-dashboard>
  <livewire:weather-forecast-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\WeatherForecastTile\WeatherForecastTileServiceProvider" --tag="dashboard-weather-forecast-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.