PreviewKit Documentation

Welcome to PreviewKit documentation. Everything you need to get preview environments running for your Pull Requests.

Quick Start

New to PreviewKit? Start here:

Getting Started →

Set up preview environments in under 5 minutes. This guide walks you through Azure infrastructure setup, GitHub configuration, and deploying your first preview environment.

Core Documentation

User Guide →

Complete guide covering:

  • Basic usage and workflow
  • Advanced configuration options
  • Multiple services support
  • Environment variables and secrets
  • Troubleshooting common issues

License Management →

Everything about licensing:

  • Getting and using license keys
  • Tier comparison and limits
  • Seat-based licensing explained
  • Upgrading or downgrading tiers
  • Usage tracking and troubleshooting

Support →

Get help when you need it:

  • Community support
  • Bug reports
  • Feature requests

What is PreviewKit?

PreviewKit automatically creates isolated preview environments for every Pull Request. When you open a PR, PreviewKit:

  1. Builds your Docker image
  2. Deploys it to Azure Container Apps
  3. Posts a comment with the preview URL

When you close the PR, it automatically cleans up all resources.

Prerequisites

Before getting started, you'll need:

  • A GitHub repository with a Dockerfile
  • An Azure account with active subscription
  • Azure CLI installed and configured
  • Owner or Contributor role on your Azure subscription

Need Help?