psyao / kami-starter
A Laravel application wired for Psyao Kami, the Laravel and Filament CMS.
Requires
- php: ^8.5
- filament/filament: ^5.10
- laravel/framework: ^13.32
- laravel/tinker: ^3.0
- psyao/kami: ^0.10
Requires (Dev)
- driftingly/rector-laravel: ^2.7
- evilmartians/lefthook: ^2.2
- fakerphp/faker: ^1.23
- larastan/larastan: ^3.13
- laravel-lang/common: ^6.8
- laravel/boost: ^2.10
- laravel/pail: ^1.2.5
- laravel/pao: ^1.0.6
- laravel/pint: ^1.32
- mockery/mockery: ^1.6
- nunomaduro/collision: ^8.6
- 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
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-16 20:08:20 UTC
README
A Laravel application wired for Psyao Kami, the Laravel and Filament CMS at home on shared hosting. Once created, the site owns this code: nothing is ever synced back from here, and everything existing sites must receive ships in the psyao/kami package.
Create a site
Requirements: PHP 8.5 with the extensions Kami lists, Composer, and, on the developer's machine only, Node for the front-end build and gitleaks for the commit hook (brew install gitleaks).
laravel new site --using=psyao/kami-starter
cd site
php artisan kami:install
kami:install asks for the first administrator, who signs in at /admin and sets an authenticator app up there; so does composer setup, which also builds the front. Without a terminal, pass the administrator's details as Kami's installation guide shows. The home page answers 404 until it is published: publish it in the admin, or seed the demo with php artisan db:seed --class=DemoSeeder, which composer setup runs. The demo publishes it and a Page with two Tags, at /about in French and /en/about in English. It also publishes two News items, listed by their Archive at /news and /en/news, and fills the primary Menu with links to the home page, the Page and the Archive.
To put the site online and deploy it again, follow Kami's deployment guide. On shared hosting, point the host's task planner at the Tick's URL, as Kami's hosting guide shows. Accept Laravel Boost when the installer offers it, or run php artisan boost:install later: either gives a coding agent Laravel's, Filament's and Kami's guidelines and skills.
What it wires
routes/web.php:Kami::routes(), the fallback route that serves every Entry at its Path, after the site's own routes.bootstrap/app.php: Kami's front security headers and CSP on thewebgroup too.app/Providers/Filament/AdminPanelProvider.php: the panel, withKamiPlugin, strict authorization, Kami's local avatar provider and Kami's admin security headers.app/Models/User.php:KamiUserwithHasKamiRoles, and Filament's MFA contracts withHasKamiMfa; only a User holding a Kami Role gets into the admin, and one who may manage Users sets an authenticator app up first.app/Filament/Resources/Users/: the Users screen, with Kami's Roles field and a one-time link for each new User to set their password;app/Policies/UserPolicy.phpopens it tokami.users.manageonly;lang/{en,fr}/users.phpare its labels. The first administrator comes fromkami:install, later Users from this screen orkami:user:grant.config/kami.php: four example types inapp/Content, aHomeSingleton at/, aPage, theTagTaxonomy itstagsField links to, andNews, whose Archive lists them newest first at/news; aprimaryMenu, one level deep, which editors fill in the admin; two Locales (fr, the default, anden) and theadministratorandeditorRoles, the editor managing Menus but not Redirects.database/migrations/*_create_kami_type_*_table.phpare the types' tables, written bykami:make:migration; a type with no Field, asTag, has none.app/Forms/ContactForm.php: a contact Form underkami.forms, its accessible markup on the home page inside<x-kami::form>(see Kami's Forms guide). Each Submission is stored; its recipient isMAIL_FROM_ADDRESS.lang/{en,fr}/kami-forms.phpname it,validation.attributesits fields;lang/fr/validation.phpcarries Laravel's validation messages in French, which Laravel does not ship.database/seeders/DemoSeeder.php: the demo, throughSaveEntry. Delete it when the site has its own content. To remove a type you have migrated, delete it fromconfig/kami.phpand drop its table withContentMigrator::dropType()in a migration.lang/{en,fr}/kami-types.php: the admin's labels for the types;lang/{en,fr}/kami-menus.php: the Menu's, also its<nav>'s accessible name;lang/fr.json: the layout's strings in French.resources/views/components/layouts/site.blade.php: a minimal accessible layout (lang, skip link, landmarks), built by Vite and Tailwind, with no JavaScript, no web font and nothing inline. Its header renders the primary Menu with<x-kami::menu handle="primary" />.resources/views/kami/home.blade.php,page.blade.phpandnews.blade.phprender the types in it, andnews-archive.blade.phpthe News Archive, with<x-kami::pagination>.public/.htaccess: no trailing-slash redirect before Laravel, so a former URL costs one 301.resources/views/errors/: 4xx pages in the site's layout; 500 and 503 inminimal.blade.php, a shell with no database query and no Vite asset, styled bypublic/errors.css.bootstrap/app.phpcallsKami::exceptions(), so they answer in the URL's Locale..github/workflows/tests.yml: Pint, Larastan, Rector and the tests on every pull request, and the Vite + Tailwind build as an artifact, so the server never runs Node.boost.json: Kami's and Filament's guidelines and skills, preselected forboost:install, which the installer runs without prompting for them.lefthook.yml,pint.json,rector.php,phpstan.neon.dist: Kami's rules and level, from the package. Hooks install withcomposer installonce the site is a Git repository.tests/ArchTest.php: Filament stays inapp/Filament,app/Providers/Filamentand theUsermodel (itsFilamentUserand MFA contracts), so a Filament major touches only them.
composer analyse runs Larastan, composer test the tests.