samfelgar/metabase-dashboard

Laravel Nova tool for embedding Metabase dashboards

2.0.0 2023-10-05 05:34 UTC

Requires

• php: ^7.4|^8.0
• laravel/framework: ^6.0|^7.0|^8.0|^9.0
• laravel/nova: ^4.0
• lcobucci/jwt: ^4.1

MIT

• nova
• laravel
• dashboard
• metabase

README

This packages provides a tool for embedding Metabase dashboards in your Laravel Nova application.

Install

Via Composer

composer require samfelgar/metabase-dashboard

Usage

First, you'll need a Samfelgar\MetabaseDashboard\DataTransferObjects\Dashboard instance. It receives four parameters: url, secret, resource and params.

PRO TIP: It's not advisable to keep secrets in your codebase. You can create a config file pointing to an environment variable and access it with config('your-config-file.secret').

$dashboard = new \Samfelgar\MetabaseDashboard\DataTransferObjects\Dashboard(
    'https://example.com',
    'your-secret',
    1, // resource id
    [
    'param' => 'value'
    ]
);

Then, on your App\Providers\NovaServiceProvider, you can register the tool:

IMPORTANT: You must pass a unique identifier as the first parameter, or else you may experience some weird behavior.

public function tools(): array
{
    return [
        (new \Samfelgar\MetabaseDashboard\MetabaseDashboard('uniqueIdentifier', $dashboard))
            ->label('Awesome Label')
            ->title('Awesome Title'),
    ];
}

TIP: You can instantiate more than one dashboard, just be sure to define a unique identifier for each of them.

Contributing

All contributions are welcome! Please open a PR.

Security

If you discover any security related issues, please email [e-mail] or open an issue.

License

The MIT License (MIT).