the-3labs-team/nova-github-cards

GitHub Commits integration with Nova Metrics

v1.0.1 2023-08-07 09:39 UTC

Requires

• php: ^8.1|^8.2
• graham-campbell/github: ^12.2
• outl1ne/nova-translations-loader: ^5.0

Requires (Dev)

• laravel/nova: ^4.0
• laravel/pint: ^1.10
• nunomaduro/larastan: 2.0
• orchestra/testbench: ^7.0
• phpunit/phpunit: ^9.5

MIT

• Stefano Novelli
• Claudio Emmolo

• php
• github
• nova
• laravel
• github-commits
• nova-metrics

README

Nova Github Cards

Enhance your Laravel Nova experience by seamlessly integrating GitHub project cards into your dashboard. This powerful package allows you to effortlessly display essential GitHub statistics, issues, commits, and other project information directly within your Nova dashboard.

Demo

Installation

You can install the package via composer:

composer require the-3labs-team/nova-github-cards

You can publish the config file with:

php artisan vendor:publish

and choose: The3LabsTeam\NovaGithubCards\NovaGithubCardsServiceProvider.

This is the contents of the published config file:

<?php

return [
    'vendor' => 'YOUR-VENDOR',
    'repository' => 'YOUR-REPO-NAME',
    'branch' => 'main',
    'per_page' => 5,
    'cache_ttl' => 0, //in seconds

    'icons' => [
        'error' => [
            'icon' => 'x-circle',
            'iconClass' => 'text-red-500',
        ],
        'success' => [
            'icon' => 'check-circle',
            'iconClass' => 'text-green-500',
        ],
    ],
];

Note: this package uses Laravel GitHub, so you need to configure it in your config/github.php file.

Usage

Add your cards to your dashboard in the cards method, for example in Dashboard\Main:

use \The3LabsTeam\NovaGithubCards\LatestCommitsTable;
use \The3LabsTeam\NovaGithubCards\LatestIssuesTable;
...

(new LatestCommitsTable()
(new LatestIssuesTable()

You can also override the config for each card, as follows:

use \The3LabsTeam\NovaGithubCards\LatestCommitsTable;
...

(new LatestCommitsTable(
    name: 'The name of the card (string)', 
    vendor: 'The name of your vendor (string)', 
    repository: 'The name of your repo (string)', 
    branch: 'The name of your branch (string)', 
    perPage: 'Total of results (int)', 
    cache: 'The cache in seconds (int)')
 )