binarytorch/larecipe-feedback

Get feedback from your users about your documentations.

Fund package maintenance!
Open Collective

Installs: 588

Dependents: 0

Suggesters: 0

Security: 0

Stars: 19

Watchers: 1

Forks: 1

Language:Vue

v1.0 2019-07-17 12:26 UTC

This package is auto-updated.

Last update: 2020-09-17 16:08:15 UTC


README

68747470733a2f2f6c617265636970652e62696e617279746f7263682e636f6d2e6d792f696d616765732f6c6f676f2e737667

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.

LaRecipe Screenshot

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>
68747470733a2f2f6c617265636970652e62696e617279746f7263682e636f6d2e6d792f696d616765732f7061636b616765732f666565646261636b2e676966
  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.