README

A reusable blog module for Laravel applications. Provides a complete blog API with posts, categories, tags, and media management out of the box.

Requirements

• PHP 8.2+
• Laravel 11 or 12
• Laravel Sanctum (for admin route authentication)

Installation

composer require sakibalimalik/laravel-blog

Configuration

1. Publish the config file

php artisan vendor:publish --tag=blog-config

This creates config/blog.php in your project:

return [
    'user_model'        => \App\Models\User::class, // Your User model
    'admin_middleware'  => ['auth:sanctum'],         // Middleware for admin routes
    'storage_disk'      => 'public',                 // Disk for media uploads
];

Update user_model if your User model lives in a different namespace.

2. Run migrations

Skip this step if your project already has blog tables.

php artisan vendor:publish --tag=blog-migrations
php artisan migrate

3. Register the routes

Add this line to your routes/api.php (or whichever route file you use):

require base_path('vendor/sakibalimalik/laravel-blog/routes/blog.php');

4. Create storage symlink (if not already done)

php artisan storage:link

Routes

All routes are prefixed with whatever prefix your route file uses (e.g. api/v1).

Public Routes (no authentication)

Admin Routes (requires auth middleware)

Posts

Categories

Tags

Media

Filtering & Pagination

All listing endpoints accept a query object and pagination object:

{
    "query": {
        "search": "laravel",
        "status": "published",
        "category": 1,
        "date_from": "2025-01-01",
        "date_to": "2025-12-31"
    },
    "pagination": {
        "page": 1,
        "per_page": 15
    }
}

Post filters

• search — searches title, content, excerpt
• status — draft, published, scheduled, archived
• category — category ID or slug
• author — author ID or name
• tag — tag ID or slug
• date_from / date_to — filter by created date
• published_from / published_to — filter by published date
• only_trashed — true to show soft-deleted posts

Category filters

• search, parent_id, root_only, has_posts

Tag filters

• search, color, min_posts

Media filters

• search, file_type, post_id, uploader

Post Status Values

Namespace Reference

All classes live under SakibAliMalik\Blog\:

SakibAliMalik\Blog\Models\Post
SakibAliMalik\Blog\Models\Category
SakibAliMalik\Blog\Models\Tag
SakibAliMalik\Blog\Models\Media
SakibAliMalik\Blog\Models\PostComment
SakibAliMalik\Blog\Models\PostRevision
SakibAliMalik\Blog\Models\PostView
SakibAliMalik\Blog\Enums\PostStatusEnum
SakibAliMalik\Blog\Enums\PostCommentStatusEnum
SakibAliMalik\Blog\Traits\ApiResponseTrait
SakibAliMalik\Blog\Traits\PaginationTrait
SakibAliMalik\Blog\Traits\FileUploadTrait
SakibAliMalik\Blog\Traits\CrudTrait

Updating

To pull the latest changes into any project:

composer update sakibalimalik/laravel-blog

License

MIT