Filament Metrics Fathom

https://github.com/jeffersongoncalves/filament-metrics-fathom
Admin
Filament Metrics Fathom is a Filament plugin that integrates Fathom Analytics into your admin panel,...
Tokens:2,859
Snippets:48
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install with Composer

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/resources/boost/skills/filament-metrics-fathom-development/SKILL.md

Install the plugin package via Composer. Run this in your project root to add the dependency.

```bash
composer require jeffersongoncalves/filament-metrics-fathom:"^1.0"
```

--------------------------------

### Publish and Run Settings Migration

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/README.md

Publish and run the settings migration from the base package. Run these commands after installation to set up the required database tables.

```bash
php artisan vendor:publish --tag="metrics-fathom-settings"
php artisan migrate
```

--------------------------------

### Install Filament Metrics Fathom via Composer

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/README.md

Install the package via Composer. Requires PHP 8.2+, Filament ^5.0, jeffersongoncalves/laravel-metrics-fathom ^1.0, and filament/spatie-laravel-settings-plugin ^5.0.

```bash
composer require jeffersongoncalves/filament-metrics-fathom:"^3.0"
```

--------------------------------

### Run Tests

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/README.md

Run the test suite for the package.

```bash
composer test
```

--------------------------------

### Configure Plugin Features

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/README.md

Configure the plugin to enable or disable features individually. Use settingsPage(false) to disable the settings page and widgets(false) to disable all widgets.

```php
FathomMetricsPlugin::make()
    ->settingsPage(false) // Disable the settings page
    ->widgets(false)      // Disable all widgets
```

--------------------------------

### Register Plugin in Panel

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/resources/boost/skills/filament-metrics-fathom-development/SKILL.md

Register the plugin in a Filament panel. Add this to your panel provider's panel() method to enable the plugin with default settings.

```php
use JeffersonGoncalves\Filament\MetricsFathom\FathomMetricsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugin(FathomMetricsPlugin::make());
}
```

--------------------------------

### Publish Translations

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/README.md

Publish the translation files for English (en) and Brazilian Portuguese (pt_BR).

```bash
php artisan vendor:publish --tag="filament-metrics-fathom-translations"
```

--------------------------------

### Register FathomMetricsPlugin in Filament Panel

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/README.md

Register the plugin in your Filament panel provider. Add the plugin to the panel's plugin list to enable it.

```php
use JeffersonGoncalves\Filament\MetricsFathom\FathomMetricsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(FathomMetricsPlugin::make());
}
```

--------------------------------

### API Configuration Form Fields

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/resources/boost/skills/filament-metrics-fathom-development/SKILL.md

Define the API configuration form fields for the settings page. The api_token field is a password input that can be revealed, and site_id expects a Fathom Site ID.

```php
TextInput::make('api_token')  // Fathom API token (password, revealable)
TextInput::make('site_id')    // Fathom Site ID (e.g., ABCDEFGH)
```

--------------------------------

### Advanced Settings Form Fields

Source: https://github.com/jeffersongoncalves/filament-metrics-fathom/blob/3.x/resources/boost/skills/filament-metrics-fathom-development/SKILL.md

Define the advanced settings form fields, which are collapsed by default. base_url defaults to https://api.usefathom.com/v1, and timezone is a searchable select with all PHP timezones.

```php
TextInput::make('base_url')   // API base URL (default: https://api.usefathom.com/v1)
Select::make('timezone')      // Timezone selector (searchable, all PHP timezones)
```
Tokens:
Raw