> ## Documentation Index
> Fetch the complete documentation index at: https://getoverlay.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Run Overlay Web locally against the development Convex backend.

## Prerequisites

* Node.js 20 or newer.
* npm.
* Access to the development Convex deployment.
* WorkOS credentials for sign-in flows.
* Stripe test credentials when testing billing.

## What This Runs

The local web app starts the Next.js browser shell, `/api/v1` route wrappers, server-side provider adapters, and Convex-backed app state. External processors such as browser automation, sandboxes, web search, analytics, and error reporting are controlled by runtime config and can be disabled for private deployments.

## Install

```bash theme={null}
npm install
cp .env.example .env.local
```

Fill in the required web environment variables before starting the app. For local web work against the development backend, prefer:

```bash theme={null}
npm run dev:with-convex
```

This pushes the development Convex deployment first, then starts `next dev`.

## First successful boot

A healthy local boot should show:

* Next.js serving the app on `localhost:3000`.
* No runtime config error page.
* Sign-in redirects using the configured WorkOS app.
* `/api/v1/capabilities` returning capability metadata.
* `/api/v1/bootstrap` returning signed-in app state after authentication.

## Verify changes

Use the smallest check that covers the change:

```bash theme={null}
npm run typecheck
npm run lint
npm run build
```

For docs changes:

```bash theme={null}
npm run docs:check
```