Skip to content

Eyevinn/open-live-studio

Repository files navigation

open-live-studio

Browser-based production controller for the Open Live broadcast platform. Built with React 19, TypeScript, Vite, and TailwindCSS v4.

Requirements

  • Node.js 23+
  • pnpm 10.33+
  • open-live backend running

Setup

pnpm install
cp .env.example .env
# Edit .env if your backend runs on a different URL

Environment variables

Copy .env.example to .env:

Variable Description Default
VITE_API_URL URL of the open-live backend API http://localhost:3000

VITE_API_URL is a build-time variable — Vite bakes it into the bundle at compile time. For OSC deployments, set it in the app's parameter store before building so it is picked up during the build step. Changing it after the build has no effect until a rebuild.

Never commit .env — it is gitignored. Use .env.example as the reference.

.env.production is committed and sets the default VITE_API_URL for production builds. The OSC parameter store value overrides it at build time if set.

Commands

# Start development server (hot reload, connects to backend)
pnpm dev

# Type-check without building
pnpm typecheck

# Type-check and build for production
pnpm build

# Serve the production build (OSC deployment — respects $PORT, defaults to 8080)
pnpm start

# Preview the production build locally
pnpm preview

# Lint
pnpm lint

Development

Start the open-live backend first, then run pnpm dev here. The dev server runs on http://localhost:5173 by default.

Sources and productions are polled from the backend every 5 seconds. All changes (add, remove, activate/deactivate) are persisted immediately via the REST API.

OSC deployment

The app is deployed on Open Source Cloud using the pnpm start script. The VITE_API_URL parameter must be set in the app's OSC parameter store before deployment so Vite can bake the correct backend URL into the bundle at build time.

Set CORS_ORIGIN on the backend to this app's OSC URL and restart the backend whenever this app's URL changes.

About

A Web App for Open Live

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages