README

This is opioniated laravel filament panel plugin to add markdown blog support. This is only backend plugin. As people can use any frontend framework to create frontend for blogflow.

It requires few pre requisites packages to work, so make sure they are available in your project.

Installation

You can install the package via composer:

composer require irajul/blogflow

If you haven't already done so, you need to publish the migration to create the tags table:

php artisan vendor:publish --provider="Spatie\Tags\TagsServiceProvider" --tag="tags-migrations"

For more information, check out Spatie's documentation.

php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="medialibrary-migrations"

You must also prepare your Eloquent model for attaching media.

For more information, check out Spatie's documentation.

You can publish and run the migrations with:

php artisan vendor:publish --tag="blogflow-migrations"
php artisan migrate

You can publish the config file with:

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

Use Blog in Filament Panel

use irajul\Blogflow\Blogflow;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            Blogflow::make()
        ])
}

Manage User Relationship

Please ensure user model has relationshio with Post Model.

<?php

namespace App\Models;

use irajul\Blogflow\Traits\HasBlog;
use Illuminate\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasBlog;
}

Config

This package needs few config to work. make sure to set disk as per your preference. If you use S3/R2 then make sure their permission has public read access.

return [
    'tables' => [
        'prefix' => 'blogflow_', // prefix for all blog tables
    ],
    'user' => [
        'model' => \App\Models\User::class,
        'foreign_key' => 'user_id',
        'columns' => [
            'name' => 'name',
        ],
    ],
    'featured_image' => [
        'thumbnail' => [
            'width' => 300,
            'height' => 300,
        ],
        'fallback_url' => 'https://images.unsplash.com/photo-1547586696-ea22b4d4235d?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=3270&q=80',
        'collection_name' => 'post_feature_image',
    ],
    'disk' => 'public',
];

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

Sponsor

NextSprints

License

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

irajul / blogflow

Maintainers

Details