README

Filament News

Filament News is a Filament plugin that provides a comprehensive news management interface for your application. It's designed to help you quickly set up a backend for managing news articles, complete with common features such as categories, tags, featured images, summaries, weight, SEO optimization, and version tracking. This package streamlines the process of integrating a robust news system into your Filament admin panel.

Note: This plugin relies on several excellent Laravel/Filament plugins. Before installing Filament News, you must ensure that all the following dependencies are installed and properly configured in your project. Filament Tree, Filament Select Tree, Eloquent Sluggable, Filament Spatie Tags Plugin, Filament Versionable, Filament SEO, Filament Curator

Important: The category feature in this plugin depends on the Filament Tree plugin. You must configure the order field of Filament Tree to use weight for proper functionality.

This package is also a standalone part of a CMS project: FilaPress.

Installation

You can install the package via composer:

composer require rectitude-open/filament-news

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-news-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-news-config"

Optionally, you can publish the translations using

php artisan vendor:publish --tag="filament-news-translations"

This is the contents of the published config file:

return [
    'cluster' => [
        'navigation_sort' => 0,
        'navigation_icon' => 'heroicon-o-newspaper',
    ],
    'news' => [
        'navigation_sort' => 0,
        'navigation_icon' => 'heroicon-o-newspaper',
        'datetime_format' => 'Y-m-d H:i:s',
        'navigation_badge' => false,
        'model' => \RectitudeOpen\FilamentNews\Models\News::class,
        'filament_resource' => \RectitudeOpen\FilamentNews\Filament\Resources\NewsResource::class,
    ],
    'news_category' => [
        'model' => \RectitudeOpen\FilamentNews\Models\NewsCategory::class,
        'page' => \RectitudeOpen\FilamentNews\Filament\Pages\NewsCategory::class,
        'navigation_sort' => 2,
        'navigation_icon' => 'heroicon-o-rectangle-stack',
    ],
    'tag' => [
        'model' => \RectitudeOpen\FilamentNews\Models\Tag::class,
        'filament_resource' => \RectitudeOpen\FilamentNews\Filament\Resources\NewsTagResource::class,
        'navigation_sort' => 3,
        'navigation_icon' => 'heroicon-o-tag',
    ],

    'editor_component_class' => \Filament\Forms\Components\RichEditor::class,
];

Usage

The package provides a cluster page that allows you to view News in your Filament admin panel.

To use the cluster page provided by this package, you need to register it in your Panel Provider first.

namespace App\Providers\Filament;

use RectitudeOpen\FilamentNews\FilamentNewsPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ->plugins([
                FilamentNewsPlugin::make()
            ]);
    }
}

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

• Aspirant Zhang
• All Contributors

License

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