Brua

Docs

Brua for developers: install the consumer side, render by id, and read how the pieces fit.

Integrating Brua needs no account. A designer publishes the images and animations in Brua; you get your organization's base URL and the asset ids, install the SDK for your stack, and render by id. Brua serves the right file for each screen, appearance and language, and a new version reaches your app after review with no release of yours.

Get started

  • Web: React, Vue, Svelte and plain HTML, with @meginhufr/brua-web.
  • iOS and macOS: the BruaKit package and a SwiftUI view.
  • Android: a Compose composable, and plain Kotlin for JVM backends.
  • .NET: a Blazor component and <picture> HTML for server-rendered pages.
  • Backends: pass ids on, forward hints, or embed a snapshot from the delivery API.
  • Build and CI: the released ids as typed constants, and pushing from a pipeline.

Concepts

  • How Brua works: the three roles, the id, the edge, and what the SDK does.
  • The lifecycle of an asset: versions, change sets, releases, rollback, deletion, and what consumers see when.
  • The single URL: what it negotiates on, the query overrides, the JSON pointer and the cache lifetimes.

Reference

  • The AssetResponse: the contract every SDK reads, field by field.
  • Delivery API: reading a release with a key, for snapshots.
  • Webhooks: signed, retried posts when releases go out, with the envelope and a verifier.
  • Command line: @meginhufr/brua-cli for pushing, pulling and reading.
  • GitHub Actions: push and pull in a workflow.
  • Figma plugin: publishing frames, and what the layer remembers.