README

Blogr — Multilingual Blog Plugin for FilamentPHP

A production-ready, multilingual blog and CMS system for Laravel & FilamentPHP v4.

Features • Installation • Documentation • Screenshots • Support

✨ Overview

Blogr turns your Laravel application into a full-featured blogging platform. Built as a FilamentPHP v4 plugin, it provides a translation-first content engine, a visual CMS page builder, role-based authoring, SEO tools, analytics integration, and a modern frontend with dark mode and theme presets — all configurable from a single admin settings page.

Why Blogr?

• 🌍 Translation-First — Posts, series, categories, tags, CMS pages, and author bios are fully translatable.
• 🧱 Visual CMS Builder — Build static pages with 23 block types, 7 templates, and gradient-aware transitions.
• 🎨 Theme System — Light/dark/auto mode, 5 color presets, 16+ configurable colors, custom fonts.
• 🔌 Extensible — Plugin architecture via BlogrExtension for third-party packages.
• 🔍 SEO Ready — Meta tags, Open Graph, Twitter Cards, JSON-LD, XML sitemaps, RSS feeds, hreflang.
• 📊 Dashboard Widgets — 9 widgets including stats, charts, scheduled posts, SEO checklist, and more.
• 🧪 Battle Tested — 1,366+ automated tests covering every major feature.
• ♿ Accessible — WCAG 2.2 AA compliant: skip navigation, keyboard-operable galleries, carousels and mega menus, descriptive link labels, screen-reader-friendly status messages, form autocomplete, focus management, minimum touch targets, visible focus indicators, accessible icon labels, and color contrast validation in admin settings.

🎯 Key Features

📸 Screenshots

Admin Dashboard

Post Editor

Frontend Blog Home

More screenshots are available in the .github/images folder on GitHub.

🚀 Quick Start

Prerequisites

• PHP 8.3+
• Laravel 12.x
• FilamentPHP v4.x
• Composer
• Node.js 18+ and npm

Install in a fresh Laravel + Filament project

# 1. Create a Laravel project
laravel new my-blog
cd my-blog

# 2. Install FilamentPHP
composer require filament/filament
php artisan filament:install --panels

# 3. Create an admin user
php artisan make:filament-user

# 4. Install Blogr
composer require happytodev/blogr
php artisan blogr:install

The installer will ask a few questions (CMS enabled, homepage type, admin path, theme setup, tutorials, demo pages) and then publish configs, run migrations, configure your User model, install frontend assets, and build everything.

After installation

1. Log in at /admin (or your configured admin path).
2. Go to Blog Posts → New Post to create content.
3. Visit Blogr Settings to customize appearance, SEO, navigation, and analytics.
4. View your blog at /blog or / if you set the blog as homepage.

For a detailed walkthrough, see INSTALL.md.

🛠️ CLI Commands

Blogr ships with several Artisan commands:

⚙️ Configuration Highlights

All settings are manageable from the Blogr Settings page in the admin panel, or directly in config/blogr.php.

Routes and homepage

'route' => [
    'prefix' => 'blog',          // Change to '' for homepage
    'frontend' => ['enabled' => true],
    'middleware' => ['web'],
],

'homepage' => [
    'type' => 'blog',            // 'blog' or 'cms'
],

Locales

'locales' => [
    'enabled' => true,
    'default' => 'en',
    'available' => ['en', 'fr'],
    'auto_detect' => false,
],

CMS pages

'cms' => [
    'enabled' => true,
    'prefix' => '',              // '', 'page', 'pages', etc.
    'templates' => [
        'default', 'landing', 'contact', 'about', 'pricing', 'faq', 'custom'
    ],
],

SEO defaults

'seo' => [
    'site_name' => ['en' => 'The blog', 'fr' => 'Le blog'],
    'default_title' => ['en' => 'Blog', 'fr' => 'Blog'],
    'twitter_handle' => '@yourhandle',
    'og' => [
        'image' => '/images/blogr.webp',
        'image_width' => 1200,
        'image_height' => 630,
    ],
    'structured_data' => [
        'enabled' => true,
        'organization' => [
            'name' => env('APP_NAME'),
            'url' => env('APP_URL'),
            'logo' => env('APP_URL').'/images/logo.png',
        ],
    ],
],

Analytics

'analytics' => [
    'enabled' => false,
    'provider' => null,          // 'google', 'plausible', 'umami', 'matomo'
    'google' => ['measurement_id' => 'G-XXXXXXXXXX'],
    'plausible' => ['domain' => 'yoursite.com'],
    'umami' => ['website_id' => null, 'src' => null],
    'matomo' => ['url' => null, 'site_id' => null],
],

📊 Dashboard Widgets

Nine widgets are available and can be enabled or disabled from Settings → Dashboard:

🧩 CMS Blocks

The CMS page builder includes 23 block types:

Content & Marketing

• Hero Banner
• Hero Carousel
• Features Grid
• Call to Action
• Rich Content (Markdown)
• Blog Posts
• Blog Title

Social Proof & Info

• Testimonials
• Team Members
• Stats & Metrics
• Timeline
• FAQ Accordion

Interactive & Media

• Image Gallery
• Video Embed
• Map
• Contact Form
• Newsletter

Decorative & Layout

• Wave Separator
• Section Separator (diagonal)
• Transition: Clip Path
• Transition: Simple
• Transition: Animation

Each block supports 5 background types (none, solid, gradient, image, pattern), independent dark-mode settings, custom colors, and text shadows.

Plugins

Blogr supports third-party plugins via the BlogrExtension interface. Plugins can register routes, Livewire components, custom link types, and settings pages.

use Happytodev\Blogr\Contracts\BlogrExtension;
use Happytodev\Blogr\Services\ExtensionRegistry;

class MyPlugin implements BlogrExtension
{
    public function getId(): string { return 'my-plugin'; }
    public function getName(): string { return 'My Plugin'; }
    public function getDescription(): string { return 'What it does.'; }
    public function getVersion(): string { return '1.0.0'; }
    public function getAuthor(): string { return 'Your Name'; }
    public function getHomepage(): ?string { return null; }
    public function getDependencies(): array { return []; }
    public function getSettingsUrl(): ?string { return null; }
    public function registerExtension(ExtensionRegistry $registry): void {}
}

Register your plugin in your service provider:

public function packageBooted(): void
{
    if ($this->app->has(ExtensionRegistry::class)) {
        $this->app->make(ExtensionRegistry::class)->register(new MyPlugin);
    }
}

🛡️ Security

Configurable admin path

Change the default /admin URL from Settings → Admin Panel, then run:

php artisan blogr:sync-admin-path

You can also set it via .env:

BLOGR_ADMIN_PATH=backoffice

Two-Factor Authentication

Add 2FA to your admin panel with Filament Breezy. Blogr provides an installer command:

php artisan blogr:install-breezy

See the Breezy documentation for full configuration details.

Roles and permissions

Blogr uses Spatie Permission with two default roles:

• Admin — full access
• Writer — can create and edit own posts, cannot publish or manage other users

🧪 Testing

Blogr is tested with 1,266 Pest PHP tests covering import/export, multilingual routing, CMS pages, blocks, SEO, widgets, permissions, and more.

cd vendor/happytodev/blogr
./vendor/bin/pest --parallel

CI runs on GitHub Actions with PHP 8.4, Laravel 12, and prefer-stable.

📚 Documentation

• Installation Guide
• Feature Overview
• CMS Pages in Navigation
• Theme Switcher
• RSS Feeds
• Language Switcher Fix
• Full docs folder

🤝 Support

Need Help?

📖 Full Documentation • 🐛 Report Bug • 💡 Request Feature

Love Blogr?

📄 License

MIT License — See LICENSE.md for details.

Created with ❤️ by Frédéric Blanc and the Laravel community.

⬆ Back to Top

Made with ❤️ using Laravel & FilamentPHP