Laravel package for providing visual feedback via screenshots.

3.0.0 2023-02-15 05:49 UTC

This package is auto-updated.

Last update: 2024-10-15 09:16:37 UTC


README

Software License Latest Version on Packagist Total Downloads

LaraFeed

A package to present feedback dialog on pages so users can send feedback. LaraFeed also captures page's screenshot and saves that too which can be useful especially when debugging what was user experiencing when they sent a feedback.

Requirements

  • PHP >= 7
  • Laravel 5.7+ | 6

Installation

Install via composer

composer require sarfraznawaz2005/larafeed

Publish package's config file by running below command:

php artisan vendor:publish --provider="Sarfraznawaz2005\LaraFeed\ServiceProvider"

It should publish config/larafeed.php config file and migration file.

Now run php artisan migrate to create larafeeds database table.

Put @include('larafeed::view') in your blade layout file.

That's it, Feedback button should now be visible on pages of your application.

Checkout config file for different options.

Screenshot

When user presses Send Feedback button, existing page's screenshot will automatically be captured and saved ofcourse without that feedback dialog.

Main Window

Adding Custom Fields

After you have published package assets, you can add custom fields by modifying file resources/views/vendor/larafeed/view.blade.php and create a migration to add fields to larafeeds table.

Misc

  • You can listen to Sarfraznawaz2005\LaraFeed\Events\FeedbackReceivedEvent::class event if need to use captured feedback in your own way.

Security

If you discover any security related issues, please email sarfraznawaz2005@gmail.com instead of using the issue tracker.

Credits

License

Please see the license file for more information.