README

Development status This package is under active development. Use in production only after thorough testing.

MKSine is a Laravel + Filament 4 CMS foundation: content, themes, plugins, hooks, menus, media, and a visual page builder.

This file is a short entry point. The canonical developer documentation lives under docs/ and is structured to power a future static documentation site without restructuring.

Developer documentation (canonical)

The full sidebar lives in docs/_nav.yml. Quick links:

Section	Start here
Getting started	Introduction → Installation → Quickstart
Plugin guides	Plugin golden path
Hook guides	Two families overview
Theme guides	Creating a theme
Geo	Global geo system
Reference	Commands, Configuration, Contracts, API stability
Operations	Deployment and hosting, Troubleshooting, Validation checklist
Project meta	Versioning, Upgrade guide, SLO

Architecture decisions: docs/adr/

Historical monolith (single long README, kept until its sections are fully extracted): docs/archive/README-v1-monolithic.md.

Features (summary)

Plugin system (mks-plugin:*), hook system (mks:discover), themes, page builder, menus, media, settings, global geo (countries/states/cities, mks:geo:import), Filament Shield permissions.

Requirements

PHP 8.2+ (composer.json: ^8.2).
Laravel 11+ compatible with Filament 4.
MySQL 5.7+, PostgreSQL 10+, or SQLite 3.8+.

Quick install

composer require miran/mksine
php artisan filament:install --panels

Register the plugin in app/Providers/Filament/AdminPanelProvider.php and remove the default Dashboard::class page from filament:install:

use Miran\Mksine\MksinePlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            MksinePlugin::make(),
        ]);
    // Do not keep ->pages([Dashboard::class]) — MKSine provides MksineDashboard.
}

Then finish setup:

php artisan mksine:install --migrate
php artisan mksine:create-super-admin

mksine:install --migrate publishes assets, migrates, clears caches, runs shield:generate, mks:discover, and filament:assets when the admin panel has MksinePlugin registered.

Full install steps and verification: docs/01-installation.md.

License

See LICENSE.md.

miran / mksine

Maintainers

Package info

Statistics

Security