# Prvue

## Docs

- [Health check](https://docs.prvue.dev/api-reference/health/health-check.md): Returns service health status and uptime.
- [Delete a preview deployment](https://docs.prvue.dev/api-reference/previews/delete-a-preview-deployment.md): Stops and removes the preview for the given deployment id (format: {projectSlug}-{prNumber}, e.g. myorg-myapp-12).
- [List preview deployments](https://docs.prvue.dev/api-reference/previews/list-preview-deployments.md): Returns all tracked preview deployments.
- [GitHub webhook](https://docs.prvue.dev/api-reference/webhook/github-webhook.md): Receives GitHub pull_request webhook events (opened, reopened, synchronize, closed). Requires X-Hub-Signature-256 header. Payload follows GitHub webhook payload format.
- [Architecture](https://docs.prvue.dev/architecture.md): System design, components, data flow, and security for Prvue
- [Configuration Reference](https://docs.prvue.dev/configuration.md): Complete reference for all configuration options in Prvue
- [Go Example](https://docs.prvue.dev/examples/go.md): Example Go repo with PostgreSQL and Redis for preview-deployer
- [Examples Overview](https://docs.prvue.dev/examples/index.md): Example repositories showing how to add preview-config and optional docker-compose.preview for Prvue
- [Laravel Example](https://docs.prvue.dev/examples/laravel.md): Example Laravel repo with PostgreSQL, Redis, and .env for preview-deployer
- [NestJS Example](https://docs.prvue.dev/examples/nestjs.md): Example NestJS repo with PostgreSQL, Redis, health endpoints, and admin seeder for preview-deployer
- [Python Example](https://docs.prvue.dev/examples/python.md): Example Python (FastAPI) repo using repo-owned docker-compose.preview.yml for preview-deployer
- [Rust Example](https://docs.prvue.dev/examples/rust.md): Example Rust repo using repo-owned docker-compose.preview.yml for preview-deployer
- [Introduction](https://docs.prvue.dev/index.md): Automated preview deployment for backend applications—isolated environments per PR on Digital Ocean
- [Quickstart](https://docs.prvue.dev/quickstart.md): Get Prvue up and running in minutes
- [Agent Handoff Prompt](https://docs.prvue.dev/reference/agent-handoff-prompt.md): Cursor/agent handoff prompt for new sessions
- [Documentation Guide](https://docs.prvue.dev/reference/documentation-guide.md): Rules and standards for generating and maintaining Prvue documentation
- [Implementation Plan](https://docs.prvue.dev/reference/implementation-plan.md): Canonical implementation plan for contributors and agents
- [Orchestrator API](https://docs.prvue.dev/reference/orchestrator-api.md): HTTP endpoints exposed by the orchestrator for health checks, webhooks, and debugging
- [How the Orchestrator Works](https://docs.prvue.dev/reference/orchestrator-how-it-works.md): Webhooks, containers per preview, and how the pieces connect
- [Testing](https://docs.prvue.dev/testing.md): Running tests, coverage, and guidelines for writing tests in Prvue
- [Troubleshooting](https://docs.prvue.dev/troubleshooting.md): Common issues and solutions for Prvue

## OpenAPI Specs

- [openapi](https://docs.prvue.dev/openapi.json)