Local Development#

OVAS API banner for local development guide

Before deploying your web client to an Omniverse Kit App Streaming instance, develop and iterate against a locally running Omniverse Kit App. This allows you to use your browser’s hot-reload dev server to get immediate feedback on UI and messaging changes without waiting for a cloud deployment cycle every time.

After the client behaves as expected locally, swapping to an Omniverse Kit App Streaming deployment requires only a stream source change, and the rest of your code stays the same. You will scaffold a local web client, run it against your Omniverse Kit App, and iterate without publishing to the cloud until you are ready.

Step 1 - Start Your Kit Application

Clone the kit-app-template repository and create a new application with Omniverse Kit App Streaming (Default) enabled, then build and launch it locally.

Step 2 - Scaffold a Local Streaming Project

Use Create OV WebRTC App to generate a ready-to-run web client configured for local streaming. Run the interactive setup wizard and select Local (direct) as the stream source:

Generate a new WebRTC application#
npx @nvidia/create-ov-web-rtc-app

The generated project connects directly to a Kit stream.

Step 3 - Run the web dev server

Install dependencies and start the Vite development server:

Install dependencies and start dev server#
npm install
npm run dev

Open http://localhost:5173/ in a Chromium-based browser. The client connects to your local Kit stream automatically on page load.

Step 4 - Iterate

With the dev server running, any changes you save to the web client source are reflected in the browser immediately with no rebuild or redeployment needed. Use this loop to develop and test your UI, custom message handling, and streaming behavior against the live Omniverse Kit App.

When You Are Ready to Deploy to Kit App Streaming

When the client works as expected locally, update your stream configuration to point to your Omniverse Kit App Streaming deployment instead of the local signaling server. Your application code, messaging logic, and event handlers carry over unchanged.

Deploy to Kit App Streaming


Summary#

You now have a local Omniverse Kit App and web client loop you can use to validate UI and messaging before you change stream endpoints. When you are ready to point the client at Omniverse Kit App Streaming, follow Deploy to Kit App Streaming.