Skip to content

Installation (core) ​

Install the backend package when you need the API/admin only, or when a UI package did not pull it in yet.

bash
composer require vigstudio/vgcomments

UI packages already require vigstudio/vgcomments:^2.0, so this step is often automatic.

Publish ​

bash
php artisan vendor:publish --tag=vgcomment-config
php artisan vendor:publish --tag=vgcomment-assets
php artisan vendor:publish --tag=vgcomment-lang   # optional

After upgrades:

bash
php artisan vendor:publish --tag=vgcomment-assets --force

Optional Composer hook:

json
{
  "scripts": {
    "post-update-cmd": [
      "@php artisan vendor:publish --tag=vgcomment-assets --force"
    ]
  }
}

Configure before migrate ​

Edit config/vgcomment.php (important defaults):

php
'prefix' => 'vgcomments',

'connection' => env('VCOMMENT_DB_CONNECTION', 'mysql'),

'table' => [
    'comments' => 'vgcomments',
    'files' => 'vgcomment_files',
    'reactions' => 'vgcomment_reactions',
    'reports' => 'vgcomment_reports',
    'settings' => 'vgcomment_settings',
],

'allow_guests' => true,

'moderation_users' => [
    'web' => [1], // your admin user ids per guard
],

SQLite example:

bash
VCOMMENT_DB_CONNECTION=sqlite

Migrate ​

bash
php artisan migrate
php artisan optimize:clear

Verify assets ​

Admin CSS/JS must exist here:

public/vendor/vgcomments/css/style.css
public/vendor/vgcomments/js/app.js

If missing, re-publish --tag=vgcomment-assets. See Deploy & assets.

Next ​

  1. Configuration
  2. Admin panel
  3. Add a UI: Livewire or Blade

MIT · Blade-first for 2.x · Livewire 4 supported