creacoon / laravel-dashboard-jira-service-management-queues-tile
JiraQueueServiceTile
1.0.1
2024-10-16 11:21 UTC
Requires
- php: ^8.3
- livewire/livewire: ^v3.5.6
- spatie/laravel-package-tools: ^1.9.2
Requires (Dev)
- larastan/larastan: ^2.0
- laravel/pint: ^1.18
- nunomaduro/collision: ^v8.4.0
- orchestra/testbench: ^v9.4.0
- pestphp/pest: ^v2.35.1
- pestphp/pest-plugin-laravel: ^v2.4.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/laravel-ray: ^1.26
README
Installation
- Require package via composer
- Place the required values in the
.env
file. - Place the tile component in your dashboard.
- Schedule the command in the
app/console/kernel.php
Composer
You can install the package via composer:
composer require creacoon/laravel-dashboard-jira-queue-tile
Env file
Place this in the .env
file.
JIRA_HOST= JIRA_AUTHENTICATION="basic_token" JIRA_USER= JIRA_API_TOKEN= JSM_VISIBLE_QUEUES=1,2,3
Config file
In the dashboard
config file, you must add this configuration in the tiles
key.
// in config/dashboard.php return [ // ... 'jira_service_queues' => [ 'jira_host' => env('JIRA_HOST'), 'jira_user' => env('JIRA_USER'), 'jira_api_token' => env('JIRA_API_TOKEN'), 'visible_queues' => explode(',', env('JSM_VISIBLE_QUEUES')), 'resolved_today_jql' => 'project = SV AND statusCategory IN (Done) AND updated > startOfDay() AND updated < endOfDay()', ],
Tile component
In your dashboard view you use the livewire:jira-service-queue-tile
component.
<x-dashboard> <livewire:jira-service-queue-tile position="a2" refresh-interval="30"/> </x-dashboard>
Schedule command
In app\Console\Kernel.php
you should schedule the following commands.
protected function schedule(Schedule $schedule) { // ... $schedule->command(FetchDataFromJiraQueueCommand::class)->everyFiveMinutes(); }
Customizing the view
If you want to customize the view used to render this tile, run this command:
php artisan vendor:publish --tag="dashboard-jira-queue-tile-views"
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
License
The MIT License (MIT). Please see License File for more information.