README

Commenter Admin Panel

Admin panel for the commenter

Description

Provides an ideal admin panel to manage the Commenter package.

Requirements

PHP : ^8.1 | ^8.2 | ^8.3
laravel/framework : ^ 10.0 | ^11.0
lakm/laravel-comments : *
filament/notifications : ^3.2
filament/tables : ^3.2

Installation

    composer require lakm/laravel-comments-admin-panel -W

    php artisan commenter-admin-panel:install

Optional

You can publish views using below command.

    php artisan vendor:publish --tag=comments-admin-panel-resources

Usage

All you need to do is navigate to the package's default route end point /admin/comments/dashboard

Config

Config file is published as comments-admin-panel.php in the config directory.

If it is missing, you can re-publish it using the command below.

php artisan vendor:publish --tag=comments-admin-panel-config

This will publish following config file

//config/comments-admin-panel.php
<?php

use LakM\Comments\AdminPanel\Middleware\AdminPanelAccessMiddleware;

return [
        'enabled' => true,
        'routes' => [
            'middlewares' => [
                'web',
                AdminPanelAccessMiddleware::class, // Removing this, allow users to access admin panel if enabled is set to true !
            ],
            'prefix' => 'admin',
        ],
        /**
         * Commentable models(must implement CommentableContract) that the admin panel must track
         * Keep empty to use models auto-discovery
         */
        'commentable_models' => [],
];

Authorization

By default, routes are enabled if it is not in production environment. You can change this behaviour by setting enabled variable to false in the config file.

'enabled' => false

Production

Before deploying to production (in production mode), the canAccessAdminPanel method must be implemented in the auth model; otherwise, you will receive a 404 status. This behaviour is handled by the AdminPanelAccessMiddleware::class middleware.

//config/comments-admin-panel.php
  public function canAccessAdminPanel(): bool
  {
     return true;
  }

Note

Don't forget to set 'enabled' => true in the config file.

Models Discovery

By default, package scan all the commentable models in App/Models namespace. You can change this behaviour by explicitly defining models you want admin panel to track.

//config/comments-admin-panel.php
return [
    'commentable_models' => [Post::class], // Admin panel only track for post class
]

Route

You can access to the admin panel visiting default route end point /admin/comments/dashboard

Prefix

By default, admin prefix is added to package's routes you can change it as following example.

'routes' => ['prefix' => 'admin'],

Middlewares

By default, web and AdminPanelAccessMiddleware::class middlewares are applied you can change it as following example.

 'routes' => [
            'middlewares' => [
                'web',
                AdminPanelAccessMiddleware::class, // Removing this, allow users to access admin panel if enabled is set to true !
            ],
        ],

Customization

You can customize all the views by publishing them using below commands,

    php artisan vendor:publish --tag=comments-admin-panel-resources

This will publish views to the \resources\views\comments-admin-panel directory.

Assets

Package's install command comments-admin-panel:install, publish assets to the \public\vendor\lakm\comments-admin-panel directory.

Here is the command to publish them manually.

    php artisan vendor:publish --tag=comments-admin-panel-assets

Build assets

You can build assets using any assets building tool. By default, package has used laravel vite plugin. Make sure to use right build directory public\vendor\lakm\comments-admin-panel\build

Important

When building assets the re should be only one input file and that is should be app.js. You can do that as following using vite.

// vite.config.js

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
   plugins: [
       laravel({
           hotFile: 'public/vendor/lakm/comments-admin-panel/comments-admin-panel.hot',
           buildDirectory: 'vendor/lakm/comments-admin-panel/build', // This is important
           input: ['resources/js/app.js'], // This is important
           refresh: true,
       }),
   ],
});

Changelog

Please see CHANGELOG for more information what has changed recently.

Security

Please see here for our security policy.

License

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

lakm / laravel-comments-admin-panel

Maintainers

Details