sunrice / cms

dev-main 2026-10-17 15:27 UTC

Requires

• php: ^8.3
• illuminate/contracts: ^13.0
• illuminate/support: ^13.0
• inertiajs/inertia-laravel: ^3.5
• intervention/image: ^4.0
• laravel/mcp: ^1.0
• spatie/laravel-honeypot: ^4.7
• spatie/laravel-package-tools: ^1.93
• spatie/laravel-permission: ^8.0
• spatie/laravel-sitemap: ^8.0
• spatie/simple-excel: ^3.10
• symfony/html-sanitizer: ^7.4

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.0
• orchestra/testbench: ^11.0
• pestphp/pest: ^4.0
• pestphp/pest-plugin-laravel: ^4.1

Suggests

• spatie/laravel-responsecache: ^8.0 (requires PHP 8.4) — enables the optional full-page cache (sunrice.cache.full_page).

MIT

• cms
• laravel
• content-management

Published on Packagist.org on 2026-10-17 15:27 UTC

README

An easy to set up and extend CMS for Laravel, built as a package — collections, blueprints, fieldsets, taxonomies, navigation, globals, assets and forms, with draft/publish workflow, translations and SEO, in the spirit of Statamic and WordPress ACF.

Requirements

• PHP 8.3 or newer
• Laravel 13
• sqlite, MySQL or PostgreSQL

Quick start

composer require sunrice/cms
php artisan sunrice:install

The installer publishes the config and the prebuilt admin assets, runs the migrations, creates the Super Admin role and offers to create a super admin user. Open the admin at /cms (set SUNRICE_ADMIN_PATH to change it).

Your user model needs Spatie\Permission\Traits\HasRoles — the installer adds it to your model if it is missing. Add a scheduler entry for scheduled publishing and submission pruning: * * * * * php artisan schedule:run.

After upgrades: php artisan sunrice:publish-assets && php artisan migrate && php artisan sunrice:sync-permissions.

Documentation

Topic	Doc
Install & configure	docs/installation.md, docs/configuration.md, docs/commands.md
Modeling content	docs/content-modeling.md, docs/custom-fields.md
Frontend	docs/templates.md, docs/blade-components.md, docs/helpers.md
Locales	docs/multilingual.md, docs/translation.md
Admin extras	docs/extending.md, docs/resources.md, docs/permissions.md, docs/forms.md, docs/assets.md
Ops	docs/mail.md, docs/caching.md, docs/upgrading.md

The same guides are readable inside the admin under Manage → Docs (permission sunrice.docs.view).

The full product contract lives in SPEC.md; the build plan in EXECUTION_PLAN.md; contributor/agent rules in AGENTS.md.

Developing the package

The repository includes a Testbench workbench app for trying the admin without a host application:

composer install
npm install && npm run build          # admin assets into dist/
vendor/bin/testbench workbench:build  # publish assets, fresh sqlite DB, seed
vendor/bin/testbench serve            # http://127.0.0.1:8000/cms

Sign in as [e-mail] / password. workbench:build resets the database; re-run it (or vendor/bin/testbench sunrice:publish-assets) after npm run build. Tests: vendor/bin/pest; frontend component checks: npm run test:frontend; code style: vendor/bin/pint.

License

MIT.