Skip to content
nimbus

Native example apps

Runnable apps built on Nimbus’s own SDK, @nimbus/nimbus: reactive documents written over HTTP and read through live WebSocket subscriptions, with no compatibility layer in between. Read the overview first if you have not made a native request yet.

The apps live under examples/nimbus/ in the source repository. Run them in place from a checkout.

Run any example

Section titled “Run any example”
Terminal window
nimbus dev

nimbus dev starts a local server for the apps to use. These apps drive Nimbus directly over the native SDK’s HTTP and WebSocket transports. They have no Nimbus function bundle, so there is no nimbus deploy step. The html app also runs on a standalone Vite dev server with npm run nimbus:example:html.

The apps

Section titled “The apps”

Browser (html). This single-page playground uses Vite with the SDK’s REST and subscription transports (@nimbus/nimbus/transports/rest). It creates a tenant, installs a schema, and inserts documents. It schedules a mutation with ctx.scheduler.runAfter(...) and watches live subscription results update.

Tasks. This app implements the shared tasks task list. It installs the tasks schema and writes over HTTP. A WebSocket subscription keeps the browser list current. The app implements create, list, toggle, delete, and live update behavior.

Agent examples

Section titled “Agent examples”

Two native-SDK examples build agents on the same document store and scheduler, documented in the Agents section:

  • Agent chat: a durable chat agent that remembers facts and schedules its own follow-ups.
  • Agent worker: a headless worker that runs a batch of jobs to completion server-side.