centrex/livewire-comments

Manege comments with livewire in laravel

v1.0.5 2024-01-03 07:10 UTC

Requires

• php: ^8.1|^8.2
• illuminate/database: ^10.0|^11.0
• illuminate/support: ^10.0|^11.0
• livewire/livewire: ^3.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^7.8
• nunomaduro/larastan: ^2.0.1
• orchestra/testbench: ^8.8
• pestphp/pest: ^2.20
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0
• rector/rector: ^0.18.12
• spatie/laravel-ray: ^1.26

MIT

• centrex

• laravel
• livewire-comments
• centrex

README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Contents

• Some Features Highlight
• Prerequisites
• Installation
• Usage Examples
• Testing
• Changelog
• Contributing
• Credits
• License

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

Prerequisites

• Livewire
• TailwindCSS
• AlpineJS

Installation

You can install the package via composer:

composer require centrex/livewire-comments

You can run the migrations with:

php artisan migrate

You can publish the config file with:

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

you can 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="comments-tailwind-config"

Usage

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

use Centrex\LivewireComments\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 Centrex\LivewireComments\Traits\HasUserAvatar;

class User extends Model
{
    use HasUserAvatar;
}

Testing

🧹 Keep a modern codebase with Pint:

composer lint

✅ Run refactors using Rector

composer refacto

⚗️ Run static analysis using PHPStan:

composer test:types

✅ Run unit tests using PEST

composer test:unit

🚀 Run the entire test suite:

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Credits

• Laravel

• Tailwind

• Livewire

• FlowBite

• centrex

• All Contributors

• commentify

License

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