Quick start

This is the developer setup of the repository. The turnkey installer is planned and is not required to explore the kit.

Requirements

• PHP 8.4 with the extensions the framework requires
• Composer 2
• Node.js and npm (for the admin/web assets)
• MySQL 8 (SQLite is used by the test suite)
• Flutter 3.47+ and Android tooling only if you build the client

Steps

From the Laravel application root (composer/):

composer install
cp .env.example .env
php artisan key:generate

Create an empty MySQL database and set the connection in .env (DB_*). Then:

php artisan migrate
php artisan theme:validate
php artisan theme:seed
php artisan storage:link
npm install
npm run build
php artisan serve

Open http://127.0.0.1:8000.

Create an admin user

The admin panel is Filament at /admin. Create a user with php artisan tinker:

use App\Models\User;
User::create([
    'name' => 'Operator',
    'email' => 'operator@example.com',
    'password' => bcrypt('change-me'),
]);

Enable two-factor authentication in the admin after the first login.

Verify the installation

php artisan theme:validate
php artisan theme:preflight
php artisan migrate:status
php artisan kit:verify

kit:verify runs the static verification suites (theme, manifest, migrations, OpenAPI, admin structure).

Explore

• Public web: / (the game web, or the product site when PRODUCT_SITE_ENABLED=true)
• Admin: /admin
• API health: /api/v1/health
• Documentation (product mode): /docs

Next steps

• Installation for the full environment and the planned installer.
• Configuration for the important environment variables.
• Theme packs to start your game.