solitweb / laravel-dashboard-currencies-tile

1.0.0 2021-05-18 16:21 UTC

Requires

• php: ^7.4|^8.0
• spatie/laravel-dashboard: ^2.0

Requires (Dev)

• phpunit/phpunit: ^9.3

MIT

• Stijn Vanouplines

• solitweb
• laravel-dashboard-currencies

Published on Packagist.org on 2021-05-18 16:25 UTC

README

This tile displays currency rates from Alpha Vantage.

This tile can be used on the Laravel Dashboard.

Installation

You can install the package via composer:

composer require solitweb/laravel-dashboard-currencies-tile

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

// in config/dashboard.php

return [
    // ...
    'tiles' => [
        'currencies' => [
            'alpha_vantage_apikey' => env('CURRENCIES_ALPHA_VANTAGES_APIKEY'),
            'from_currency' => 'BTC',
            'to_currency' => 'EUR',
            'refresh_interval_in_seconds' => 60,
        ],
    ],
];

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

// in app/console/Kernel.php

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

Usage

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

<x-dashboard>
    <livewire:currencies-tile position="a1" title="Currencies" />
</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\CurrenciesTile\CurrenciesTileServiceProvider" --tag="dashboard-currencies-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 [e-mail] instead of using the issue tracker.

Credits

• Alpha Vantage
• Spatie
• All Contributors

License

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