Documentation / Start here

Start building

Run your first local Resource workflow.

ROM 0.1.0 · SOURCE CANDIDATE Markdown

ROM is a backend-first Rust framework for reactive applications. Start with the maintained local workshop.

Get the source

Clone the repository. Enter its directory.

sh
git clone https://github.com/pmikstacki/ROM.git
cd ROM

Use the toolchain declared by the selected checkout. Read rust-toolchain.toml and the NixOS instructions.

Run the workshop

Run the SQLite smoke workflow.

sh
./demo/run smoke

Run the same workflow with redb.

sh
./demo/run smoke redb

The workshop demonstrates declarations, mutations, live queries and event history. Read the author workshop for server commands.

Inspect the public consumer

The independent consumer declares a Task and a Setting through public interfaces.

sh
cargo run -p rom-consumer --locked

It creates a Task, observes query membership and invokes its completion action. Inspect the complete consumer and Task declaration.

Choose your next step

Read the Resource model for the lifecycle. Use actions and inputs to declare behavior. Use queries to observe results. Use workspace composition for Svelte integration.

Verify your checkout

Run the local verifier before distributing changed source.

sh
./scripts/check

A selected example does not establish full release acceptance. Read release support for accepted evidence and remaining limits.

This page follows the captured repository source.View the source