mirror of
https://github.com/MarijnDoeve/TijdVoorDeTest.git
synced 2026-07-11 12:28:23 +02:00
Marijn
33a0e8a584
* Avoid dev port clashes and isolate docker compose per git worktree Default dev ports (80/443/5432) clash with other projects' compose stacks. Remap them to 8080/8443/5433+ by default, and add `just init` (auto-run by `just up`) to generate a per-worktree `.env.local` with a unique COMPOSE_PROJECT_NAME, image tag, and free host ports, so multiple worktrees can run `just up` concurrently without sharing containers, volumes, images, or ports. * Pin CI to port 80 for the HTTP reachability check; use 5430 as default Postgres dev port CI runs in an isolated single-purpose runner with no port-clash concern, so pin the HTTP reachability check back to port 80 explicitly rather than changing the dev default. Also move the default dev Postgres port range from 5433 to 5430, since 5433 clashes with other commonly used local projects. * Fix Justfile init: propagate free_port failures and use portable hash free_port exhaustion was swallowed inside a command substitution used as an echo argument, silently writing empty ports to .env.local. shasum is also not guaranteed on stripped-down Linux hosts.
168 lines
6.2 KiB
Markdown
168 lines
6.2 KiB
Markdown
# Tijd voor de test
|
|
|
|
|
|
|
|
PHP/Symfony application for WIDM-style quiz management.
|
|
Built with FrankenPHP, PostgreSQL, and Docker.
|
|
|
|
> **Disclaimer:** This is an unofficial, non-commercial, open-source fan
|
|
> project. It is not affiliated with, endorsed by, or associated with
|
|
> *Wie is de Mol?* (produced by IDTV, broadcast by AVROTROS/NPO) or
|
|
> *De Mol* (produced by Woestijnvis, broadcast by Play/De Vijver Media).
|
|
> *Wie is de Mol?* and *De Mol* are trademarks of their respective rights
|
|
> holders. No copyright infringement is intended.
|
|
|
|
## Requirements
|
|
|
|
- Docker
|
|
- [Just](https://just.systems) (`brew install just`)
|
|
|
|
## Local development
|
|
|
|
```bash
|
|
just up # Start PHP + PostgreSQL containers
|
|
just migrate # Run pending database migrations
|
|
just fixtures # Load dev fixtures (truncates first)
|
|
```
|
|
|
|
`just up` first runs `just init`, which generates a `.env.local` (gitignored)
|
|
with a unique `COMPOSE_PROJECT_NAME`, image tag and free host ports for this
|
|
checkout, so multiple worktrees/clones can run at the same time without their
|
|
containers, volumes, images or ports colliding. Run `just ports` to see the
|
|
ports assigned to the current checkout — the app is served at
|
|
`https://localhost:<HTTPS_PORT>` (self-signed cert — run `just trust-cert` on
|
|
macOS to trust it).
|
|
|
|
### Useful commands
|
|
|
|
```bash
|
|
just shell # Shell inside the running PHP container
|
|
just shell-run # Shell in a fresh one-off container
|
|
just stop # Stop containers (keep volumes)
|
|
just down # Stop and remove containers
|
|
just clean # Nuclear: remove containers + volumes + generated files
|
|
just exec <cmd> # Run any command inside the PHP container
|
|
```
|
|
|
|
### Environment
|
|
|
|
Copy `.env` and override locally via `.env.local` (not committed):
|
|
|
|
| Variable | Description |
|
|
|----------------|-------------------------------------|
|
|
| `APP_SECRET` | Symfony app secret |
|
|
| `DATABASE_URL` | PostgreSQL DSN (auto-set in Docker) |
|
|
| `SENTRY_DSN` | Sentry error tracking |
|
|
| `DEFAULT_URI` | Base URL for CLI-generated links |
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
just test # Full PHPUnit suite
|
|
just test tests/Path/To/TestFile.php # Single file
|
|
just test --coverage-html var/coverage # HTML coverage report
|
|
just reload-tests # Drop/recreate test DB + migrate + test fixtures
|
|
```
|
|
|
|
Tests use a separate database configured via `.env.test`. The DAMA
|
|
Doctrine bundle wraps each test in a transaction that is rolled back after.
|
|
`just reload-tests` loads the `--group=test` fixtures; `just fixtures`
|
|
loads the dev group and is unrelated to the test database.
|
|
|
|
## Code quality
|
|
|
|
All checks run in CI and must pass before merging.
|
|
|
|
```bash
|
|
just fix-cs # Auto-fix PHP-CS-Fixer + Twig-CS-Fixer
|
|
just phpstan # PHPStan static analysis (level 8)
|
|
just rector # Apply Rector modernizations
|
|
just rector --dry-run # Preview Rector changes without applying
|
|
```
|
|
|
|
## Database
|
|
|
|
```bash
|
|
just migrate # Run pending migrations
|
|
just fixtures # Load dev fixtures
|
|
bin/console make:migration # Generate a new migration (inside container)
|
|
```
|
|
|
|
Migrations live in `migrations/` (namespace `DoctrineMigrations`). Test
|
|
fixtures are in `src/DataFixtures/` loaded with `--group=test`.
|
|
|
|
## Translations
|
|
|
|
```bash
|
|
just translations # Extract/update nl translation strings into translations/
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Create a branch from `main` — use a prefix like `feat/`, `fix/`,
|
|
or `docs/`.
|
|
2. Open a pull request; CI must pass before merging.
|
|
3. Install the pre-commit hook (see below) to catch issues before pushing.
|
|
|
|
### Pre-commit hook
|
|
|
|
A pre-commit hook lives in `.githooks/pre-commit`. Install it once after cloning:
|
|
|
|
```bash
|
|
just install-hooks
|
|
```
|
|
|
|
On every commit it runs automatically, **only on staged files**:
|
|
|
|
| Staged file type | Tools run |
|
|
|-------------------------|------------------------------------------------------------------------------|
|
|
| `.php` | Rector → PHP-CS-Fixer (auto-fix + re-stage), then PHPStan (blocks on errors) |
|
|
| `.twig` | Twig-CS-Fixer (auto-fix + re-stage) |
|
|
| Other (docs, config, …) | Nothing — commit proceeds immediately |
|
|
|
|
If the PHP container is not running, the hook falls back to
|
|
`docker compose run --rm` so checks still execute. PHPUnit is not
|
|
run in the hook; CI covers that.
|
|
|
|
## Deployment
|
|
|
|
Docker images are published to `ghcr.io/marijndoeve/tijdvoordetest`
|
|
for each tagged release.
|
|
|
|
### First-time setup
|
|
|
|
1. Copy `compose.yaml` and `compose.prod.yaml` to your server.
|
|
2. Create a `.env.prod.local` file with the required variables (see below).
|
|
3. Start the stack — migrations run automatically on container start:
|
|
|
|
```bash
|
|
IMAGE_TAG=latest docker compose -f compose.yaml -f compose.prod.yaml up -d
|
|
```
|
|
|
|
### Updating to a new version
|
|
|
|
```bash
|
|
IMAGE_TAG=<tag> docker compose -f compose.yaml -f compose.prod.yaml pull
|
|
IMAGE_TAG=<tag> docker compose -f compose.yaml -f compose.prod.yaml up -d
|
|
```
|
|
|
|
### Required environment variables
|
|
|
|
| Variable | Description |
|
|
|----------------------------|---------------------------------------------|
|
|
| `IMAGE_TAG` | Image tag to run (e.g. `1.2.3` or `latest`) |
|
|
| `APP_SECRET` | Random secret string for Symfony |
|
|
| `CADDY_MERCURE_JWT_SECRET` | JWT secret for the Mercure hub |
|
|
| `POSTGRES_PASSWORD` | PostgreSQL password |
|
|
| `MAILER_DSN` | Mailer transport DSN |
|
|
| `MAILER_SENDER` | From address for emails |
|
|
| `SENTRY_DSN` | Sentry project DSN (optional) |
|
|
|
|
The `compose.prod.yaml` configures Traefik labels for TLS termination at
|
|
`tijdvoordetest.nl`. Adjust the `traefik` labels in that file if you're
|
|
hosting on a different domain or using a different reverse proxy.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|