Table of Contents
Installation
Docker (Quick Start)
Prerequisites
- Docker Desktop with the Docker daemon running
Prepare secrets
APP_KEY
andJWT_SECRET
must be set as environment variables before the container starts.
# APP_KEY lokal generieren (einmalig)
php artisan key:generate --show
# JWT_SECRET generieren (einmalig)
openssl rand -base64 32
Set both values in a.env
file or as shell exports:
export APP_KEY="base64:DEIN_GENERIERTER_KEY=="
export JWT_SECRET="DEIN_GENERIERTES_SECRET"
Start
docker compose up --build -d
| Address | Purpose |
|---|---|
http://localhost:18080/ |
| Application |
|http://localhost:18080/up
| Health Check |
Upon first startup, the entrypoint automatically creates the SQLite database and runs all migrations.
Stop
docker compose down
Data is preserved in the Docker volumeregsys_storage
.
Local Development
Prerequisites
- PHP 8.4+ with the extensions
pdo_sqlite
,zip
- Composer 2
- Node.js 24+ with npm
Initial Setup
cd RegSys
composer setup
composer setup
performs:composer install
,.env
copy,APP_KEY
generate, database migrations,npm install
, and frontend build.
Development server
composer dev
Starts the following in parallel: Laravel backend (port 8000), queue worker, Pail log viewer, and Vite HMR.
Alternatively, start individually:
php artisan serve # Backend auf Port 8000
npm run dev # Vite mit Hot Module Replacement
php artisan queue:listen # Queue-Worker
Run a single test
php artisan test --filter=EventTest