README

A Feature board plugin for Volet - Allow users to suggest and vote for features

Demo

Installation

You can install the package via composer:

composer require mydnic/volet-feature-board

You can publish the config file with:

php artisan vendor:publish --tag="volet-feature-board-config"

You can publish and run the migrations with:

php artisan vendor:publish --tag="volet-feature-board-migrations"
php artisan migrate

Publish the assets with:

php artisan vendor:publish --tag="volet-feature-board-assets" --force

Usage

Register the plugin in VoletServiceProvider

 $volet->register(
     (new VoletFeatureBoard())
         ->addCategory(
             slug: 'idea',
             name: 'Idea',
             icon: 'https://api.iconify.design/lucide:lightbulb.svg?color=%23888888'
         )
         ->addCategory(
             slug: 'issue',
             name: 'Issue',
             icon: 'https://api.iconify.design/lucide:wrench.svg?color=%23888888'
         )
 );

Notification

You can choose to be notified when a new feature is submitted by setting the mail_notification config to true and adding the emails to notify in the send_mails_to array.

This will trigger an email notification, so be sure to have a mail driver configured.

If you wish to customize the notification, you can create your own notification class and trigger it via an observer.

Issue with Tailwind

This package was built with TailwindCSS, to demonstrate that it's possible to use any framework and have a final compiled javascript that can be used by Volet, even in an application that does not use TailwindCSS.

However, there is a known issue with TailwindCSS that makes some utilities not working properly when compiled into a Web Component.

Issue link: tailwindlabs/tailwindcss#15005

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Clément Rigo
• All Contributors

License

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