core

PSFS is a lightweight PHP framework for MVC/API applications (Twig + Propel + Symfony components).

5-minute setup

Prerequisites:

• Docker + Docker Compose
• Git

The validation baseline is PHP 8.3. Compose defaults to PHP 8.5, so select the baseline explicitly with PHP_VERSION=8.3 docker compose up -d when validating changes (see PHP compatibility).

docker compose up -d
docker compose ps
docker exec psfs-php-1 php -v
docker exec psfs-php-1 composer install --no-interaction --prefer-dist

If your PHP container name is not psfs-php-1:

docker compose ps
docker ps --format '{{.Names}}'

Daily command map

# Run key tests
docker exec psfs-php-1 php vendor/bin/phpunit --no-coverage --filter '/(AuthApiTest|RequestResponseSecurityContractTest)/'

# List PSFS CLI commands
docker exec psfs-php-1 php src/bin/psfs list

# Security local pre-check (act)
act push --container-architecture linux/amd64

Choose your path

Onboarding path

1. Read Operations Playbook
2. Read DTO Validation Engine
3. Execute the "First day" flow
4. Use troubleshooting matrix when blocked

Core contributor path

1. Read Operations Playbook
2. Read DTO Validation Engine
3. Read Propel Workflow
4. Run key tests and validate changes in Docker

Propel models and migrations

For operational Propel flow (schema, model generation context, migration execution, rollback, failure modes), see:

• Propel Workflow

Documentation index

Full documentation site: docs/README.md.

• Operations Playbook
• DTO Validation Engine
• Propel Workflow
• PHP compatibility
• Security overview
• Security policy
• Admin UI

Rules

• Run project commands inside Docker containers.
• Keep command blocks explicitly tagged as validated or example-only.