psyao / kami
Psyao Kami: a Laravel and Filament CMS for developers, at home on shared hosting.
Requires
- php: ^8.5
- ext-fileinfo: *
- ext-xmlwriter: *
- filament/filament: ^5.10.2
- intervention/image: ^4.2
- laravel/framework: ^13.32
- league/commonmark: ^2.8.1
- spatie/laravel-package-tools: ^1.93
- ueberdosis/tiptap-php: ^2.2
Requires (Dev)
- driftingly/rector-laravel: ^2.7
- evilmartians/lefthook: ^2.2
- inertiajs/inertia-laravel: ^3.0
- larastan/larastan: ^3.13
- laravel/boost: ^2.10
- laravel/pint: ^1.32
- orchestra/testbench: ^11.3
- pestphp/pest: ^5.3
- pestphp/pest-plugin-browser: ^5.2
- pestphp/pest-plugin-laravel: ^5.0
- phpstan/phpstan-deprecation-rules: ^2.0
- rector/rector: ^2.8.3
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
A Laravel and Filament CMS for developers, at home on shared hosting.
Psyao Kami, Kami for short, is a Composer package. Its admin is a plugin on your own Filament panel, and a site's content model is PHP code: Kami adds what a site needs without taking over the application. Everything runs on shared hosting with no cron, queue worker, Redis or Node on the server, and nothing essential depends on a remote service.
Kami is in early development: so far it covers installation, the environment check and the admin's wiring.
Requirements
- PHP 8.5 or later, with the extensions listed in Installation
- Laravel 13.32 or later and Filament 5.10.2 or later
- SQLite, MySQL 8.4, MariaDB 10.11 or PostgreSQL 15 or later
Install
A new site starts from the starter kit:
laravel new site --using=psyao/kami-starter
cd site
php artisan kami:install
php artisan serve
kami:install asks for the first administrator, who signs in at /admin. To add Kami to an application you already have, see Existing application.
Documentation
- Installation: requirements, creating a site,
kami:doctorandkami:install - Existing application: adding Kami to a Laravel application and its panel
- Content types: declaring a type and its Fields, writing and reading Entries
- Blocks: declaring a Block, offering it in rich text, its modal, validation, References and view
- Menus: declaring a Menu, its items,
<x-kami::menu>with the Trail,Kami::menu()and the actions that write items - Redirects: the admin's Redirects page,
SaveRedirectandDeleteRedirect, 301, 302 and 410, query-string sources and theRedirectmodel - Multilingual: Locales, Translations, Shared Fields and Fallback with
lang - Publishing: Draft, Scheduled and Published, validation, slugs, Content events, and why
SaveEntrydoes not authorise - Users and roles:
KamiUser, Roles inconfig/kami.php, Permissions and strict authorization - Audit log: what Kami records, privacy, recording your own events with
RecordAuditEvent, and batches - Routing and rendering:
Kami::routes(), Paths, a type'srender()and error pages (Kami::exceptions()) - Front stacks: your own Livewire components and Inertia pages on both mounts, cached pages and the strict front policy
- Page cache: what is cached and when it goes stale,
Kami::withoutPageCache(),Kami::remember(),Kami::flushCache()andkami:cache:clear - SEO: the indexable switch (
KAMI_INDEXABLE),X-Robots-Tagand therobots.txtkami:installwrites - Security: the front and admin Content Security Policies, extending them, and the options that weaken them
- Scheduler:
Kami::schedule(),kami:tick, overdue tasks and a server's crontab - Forms: declaring a Form, its accessible markup, protection without a session, and Submissions
- Imports: moving a running site's content into Kami with an
app:import:<source>command, Legacy ids and replays - Hosting: what Kami needs from shared hosting and from a server
- Deployment: the first deploy and every later one, on Infomaniak shared hosting or a server
- Decision records: why Kami is built the way it is
Contributing to Kami itself: Development.
Licence
MIT, see LICENSE.md.