README

LaRecipe Feedback

Get feedback from your users about your documentations.

LaRecipe 🍪

LaRecipe is simply a code-driven package provides an easy way to create beautiful documentation for your product or application inside your Laravel app.

Getting Started

1. Install the package via composer.

composer require binarytorch/larecipe-feedback

1. Run the migration

php artisan migrate

1. Use the VueJs component provided by the package at the end of each .md file you want to receive feedback about.

<larecipe-feedback></larecipe-feedback>

1. You can customize the component via the available props:

The document prop is just an identified to let you see the feedback results about specific page, if the value is not provided the package will take the url location's path.

<larecipe-feedback
    document="document id"
    title="the title of the feedback"
    message="the response message"
    ></larecipe-feedback>

Note: this package doesn't come with Admin dashboard, you can setup that by yourself or see the results directly from the DB.

See full documentation

License

This library is licensed under the MIT License - see the LICENSE.md file for details.