https://github.com/ryangjchandler/filament-data-studio

Low configuration exports and data analysis for Filament.
https://github.com/ryangjchandler/filament-data-studio

Last synced: 3 months ago
JSON representation

Low configuration exports and data analysis for Filament.

• Host: GitHub
• URL: https://github.com/ryangjchandler/filament-data-studio
• Owner: ryangjchandler
• License: mit
• Created: 2023-12-07T11:54:09.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-08T22:15:00.000Z (7 months ago)
• Last Synced: 2024-10-14T08:27:59.269Z (3 months ago)
• Language: PHP
• Homepage:
• Size: 72.3 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# Low configuration exports and data analysis for Filament.

[![Latest Version on Packagist](https://img.shields.io/packagist/v/ryangjchandler/filament-easy-export.svg?style=flat-square)](https://packagist.org/packages/ryangjchandler/filament-easy-export)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ryangjchandler/filament-easy-export/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ryangjchandler/filament-easy-export/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ryangjchandler/filament-easy-export/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ryangjchandler/filament-easy-export/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/ryangjchandler/filament-easy-export.svg?style=flat-square)](https://packagist.org/packages/ryangjchandler/filament-easy-export)

## Installation

You can install the package via Composer:

```bash

composer require ryangjchandler/filament-data-studio

```

Once the package is installed, us the `filament-data-studio:install` command to publish and run migrations.

```php

php artisan filament-data-studio:install

```

## Usage

Register the plugin on your `Panel`.

```php

use RyanChandler\DataStudio\DataStudioPlugin;

$panel

    ->plugin(DataStudioPlugin::make());

```

Add the `ExportAction` to one of your `Resource` tables.

```php

use RyanChandler\DataStudio\Actions\ExportAction;

public static function table(Table $table): Table

{

    return $table

        ->columns([

            // ...

        ])

        ->filters([

            // ...

        ])

        ->headerActions([

            ExportAction::make(),

        ]);

}

```

Open up the resource inside of your panel and start exporting data!

### Using a custom `Export` model

If you wish to change the `Export` model and extend it with your own columns, you can do this by creating a model of your own that extends the base `Export` model and then configuring the plugin to use the new model.

```php

use RyanChandler\DataStudio\Models\Export as BaseExport;

class Export extends BaseExport

{

    //

}

```

Inside of your `PanelProvider`:

```php

use App\Models\Export;

$panel

    ->plugin(

        DataStudioPlugin::make()

            ->exportModelClass(Export::class)

    );

```

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Ryan Chandler](https://github.com/ryangjchandler)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.