dashboard

Replay library hosted at app.replay.io

Getting started

# Setup environment variables
cp .env.sample .env.local

# Fill in .env.local (see Configuration below)

# Install dependencies
pnpm install

# Run dev server (localhost:8080)
pnpm dev

Configuration

The server reads environment variables from different places depending on where it is running:

• The local server loads values from the .env.local file
• Preview and production deployments load values from Vercel Environment variables

Automated scripts that build preview and production deployments are configured using GitHub secrets.

The specific URLs (hosts and paths) that support authentication are configured in the Auth0 "Replay" project.

The values required by the local .env.local file can be copied out of either 1Password or Vercel Environment variables. When in doubt, reach out to one of the previous contributors.

Running the server

In most cases, Library development can be done against the production version of Replay DevTools. However you can also run a local version of both Dashboard and DevTools.

Developing against production

To run Dashboard locally, paired with the production DevTools project:

pnpm dev:prod

At this point the Dashboard will be accessible at localhost:8080 and will open recordings using the production deployment of the DevTools application.

Local development

To run both the DevTools and Dashboard projects locally:

# Dashboard root (this project)
pnpm dev:local

# DevTools root
yarn dev:local

At this point the Dashboard will be accessible at localhost:8080 but it will not load recordings. To be able to test the end-to-end interaction of both apps, use localhost:8081. It will serve both Dashboard and DevTools routes.