Skip to main content
Prvue creates per-PR environments for your backend. These example repositories show how to add preview-config.yml, optional docker-compose.preview.yml (or .yaml), and health checks so your app works with the orchestrator.

​
Supported frameworks

​
Example repositories

NestJS example

PostgreSQL, Redis, health/stats/admins. Supported framework (built-in template).

Laravel example

Laravel, PostgreSQL, Redis, .env. Supported framework (built-in template).

Go example

Go, PostgreSQL, Redis. Supported framework (built-in template).

Python example

FastAPI, Postgres, Redis. Supported framework (built-in template); can use repo-owned compose for custom needs.

Rust example

Rust API, Postgres, Redis. Supported framework (built-in template); can use repo-owned compose for custom needs.

​
What to add in your repo

  1. preview-config.yml (repository root)
    • framework: nestjs | go | laravel | rust | python.
    • database: postgres | mysql | mongodb.
    • health_check_path: path the orchestrator will poll (e.g. /health).
    • Required: app_port, app_port_env, app_entrypoint. Optional: build_commands, startup_commands, extra_services (e.g. redis), env, dockerfile.
  2. docker-compose.preview.yml or docker-compose.preview.yaml (optional for all supported frameworks)
    • For NestJS, Laravel, Go, Rust, or Python you can omit it and use the generated compose from the built-in template.
    • To customize services or use another stack, put a repo-owned compose file with app and db services; do not set host ports—the orchestrator injects them.
  3. Health endpoint
    • Your app must expose the path you set in health_check_path and return 200 when ready.
If example repos are private or not yet published, replace repo URLs in the subpages with your own; the structure and key files are the same.