neonbang/laravel-crud-sourcing

Watch and report on CRUD events within your Laravel application

dev-main 2024-11-04 18:03 UTC

This package is auto-updated.

Last update: 2025-04-04 18:52:44 UTC


README

Do NOT use this in production yet. We are still testing internally on some projects. We'll keep you posted.

Watch and report on your Laravel CRUD events

Latest Version on Packagist Total Downloads

What problem are we solving here?

We were getting sick of adding columns to database tables that didn't really fit (something like last_notification_sent_without_response). We also were getting tired of creating report queries that were slow.

Pre-Production Notes

  • This currently relies heavily on the zoha/laravel-meta package.
    • We are finding a few bugs (and submitting PR's like this one: Zoha/laravel-meta#36)
    • Some functionality doesn't quite fit what we need so we may "decorate" it in the future or build out our own implementation of a "meta-able" flow
    • By having this we do have an additional meta.php configuration file in config/
  • There are not tests yet! Don't worry. We'll add them soon. We currently test it within our private repo applications so it's currently being tested via higher level feature tests using relevant business domain problems.

Installation

You can install the package via composer:

composer require neonbang/laravel-crud-sourcing

You can publish the configuration and run the migrations with:

php artisan vendor:publish --tag="laravel-crud-sourcing-config"
php artisan migrate

You can publish just the config file with:

php artisan vendor:publish --tag="laravel-crud-sourcing-config"

This is the contents of the published config file:

return [
    'model_metadata_map' => [],
];

Usage

Coming soon...

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.