https://github.com/owenvoke/laravel-dashboard-cloudflare-stats-tile
A tile for Laravel Dashboard that displays statistics from Cloudflare
https://github.com/owenvoke/laravel-dashboard-cloudflare-stats-tile
laravel laravel-dashboard laravel-dashboard-tile php
Last synced: over 1 year ago
JSON representation
A tile for Laravel Dashboard that displays statistics from Cloudflare
- Host: GitHub
- URL: https://github.com/owenvoke/laravel-dashboard-cloudflare-stats-tile
- Owner: owenvoke
- License: mit
- Created: 2020-04-30T14:15:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-05T07:58:52.000Z (almost 6 years ago)
- Last Synced: 2025-03-28T02:38:43.527Z (over 1 year ago)
- Topics: laravel, laravel-dashboard, laravel-dashboard-tile, php
- Language: PHP
- Homepage: https://packagist.org/packages/owenvoke/laravel-dashboard-cloudflare-stats-tile
- Size: 27.3 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Cloudflare Statistics Tile
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Style CI][ico-styleci]][link-styleci]
[![Total Downloads][ico-downloads]][link-downloads]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
A tile for Laravel Dashboard that displays statistics from Cloudflare
## Install
Via Composer
```bash
$ composer require owenvoke/laravel-dashboard-cloudflare-stats-tile
```
## Usage
In the `dashboard` config file, you must add this configuration in the `tiles` key. The `domains` should contain any domain id that you want to display on the dashboard.
```php
// in config/dashboard.php
return [
// ...
'tiles' => [
'cloudflare_stats' => [
'key' => env('CLOUDFLARE_KEY'),
'email' => env('CLOUDFLARE_EMAIL'),
'domains' => ['domain-ids-array'],
],
],
];
```
In `app\Console\Kernel.php` you should schedule the `OwenVoke\CloudflareStatsTile\Commands\FetchCloudflareStatisticsCommand` to run every `x` minutes.
```php
// in app/console/Kernel.php
protected function schedule(Schedule $schedule)
{
$schedule->command(\OwenVoke\CloudflareStatsTile\Commands\FetchCloudflareStatisticsCommand::class)->everyThirtyMinutes();
}
```
In your dashboard view you use the `livewire:cloudflare-stats-tile` component.
```blade
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
```bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.
## Credits
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Treeware
You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees [here][link-treeware-gifting].
Read more about Treeware at [treeware.earth][link-treeware].
[ico-version]: https://img.shields.io/packagist/v/owenvoke/laravel-dashboard-cloudflare-stats-tile.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/workflow/status/owenvoke/laravel-dashboard-cloudflare-stats-tile/Continuous%20Integration.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/260230881/shield
[ico-downloads]: https://img.shields.io/packagist/dt/owenvoke/laravel-dashboard-cloudflare-stats-tile.svg?style=flat-square
[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square
[link-packagist]: https://packagist.org/packages/owenvoke/laravel-dashboard-cloudflare-stats-tile
[link-github-actions]: https://github.com/owenvoke/laravel-dashboard-cloudflare-stats-tile/actions
[link-styleci]: https://styleci.io/repos/260230881
[link-downloads]: https://packagist.org/packages/owenvoke/laravel-dashboard-cloudflare-stats-tile
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://offset.earth/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: ../../contributors