usamamuneerchaudhary/commentify

Easy Laravel Livewire Comments with TailwindCSS UI

1.5 2024-02-28 07:03 UTC

Requires

• php: ^8.1
• illuminate/database: *
• illuminate/support: *
• livewire/livewire: ^3.0

Requires (Dev)

• orchestra/testbench: ^v8.0.4
• phpunit/phpunit: ^10.0

MIT

• Usama Muneer

• comments
• livewire
• laravel-livewire
• usamamuneerchaudhary
• livewire-comments
• commentify

README

Introduction

Commentify is a powerful Laravel Livewire package designed to provide an easy-to-integrate commenting system for any model in your Laravel application. Powered by Livewire, this package offers a seamless commenting experience that is powered by Tailwind UI, making it easy for users to engage with your content. With features like comments pagination and YouTube-style like/unlike buttons, this package is perfect for applications that require robust commenting capabilities. Additionally, guest users can like and unlike comments based on their IP addresses. Mentions can be used with "@" to tag specific users in replies and edits, while Markdown support allows for rich formatting in comments. Whether you're building a blog, an e-commerce platform, or any other type of web application, Commentify is a powerful tool for enhancing user engagement and collaboration.

Some Features Highlight

• Easy to integrate
• Supports Laravel 10+
• Supports Livewire 3
• Livewire powered commenting system
• Tailwind UI
• Add comments to any model
• Nested Comments
• Comments Pagination
• Youtube style Like/unlike feature
• Guest like/unlike of comments (based on IP & UserAgent)
• Mention User with @ in Replies/Edits
• Markdown Support

Prerequisites

• Livewire
• TailwindCSS
• AlpineJS

Installation Guide

You can install the package via composer:

composer require usamamuneerchaudhary/commentify

Register Service Provider

Add the service provider in config/app.php:

Usamamuneerchaudhary\Commentify\Providers\CommentifyServiceProvider::class,

Run Migrations

Once the package is installed, you can run migrations, php artisan migrate

Publish Config File

 php artisan vendor:publish --tag="commentify-config"

This will publish commentify.php file in config directory. Here you can configure user route and pagination count etc.

Publish tailwind.config.js file,

This package utilizes TailwindCSS, and use some custom configurations. You can publish package's tailwind.config. js file by running the following command:

php artisan vendor:publish --tag="commentify-tailwind-config"

Usage

In your model, where you want to integrate comments, simply add the Commentable trait in that model. For example:

use Usamamuneerchaudhary\Commentify\Traits\Commentable;

class Article extends Model
{
    use Commentable;
}

Next, in your view, pass in the livewire comment component. For example, if your view file is articles/show.blade. php. We can add the following code:

<livewire:comments :model="$article"/>

Additionally, add the HasUserAvatar trait in App\Models\User, to use avatars:

use Usamamuneerchaudhary\Commentify\Traits\HasUserAvatar;

class User extends Model
{
    use HasUserAvatar;
}

Tests

composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Laravel
• Tailwind
• Livewire
• FlowBite
• All Contributors

License

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