Skip to content

Quickstart

Requires Install (stable Rust; Node for UI / codegen paths). Pick one path — they are independent.

Path A — Playground (no server)

Build a small app in the browser in three steps: Data → Screens → Try it. No install for the hosted site.

Hosted: play.eelden.dev

Short path

  1. Open the link.
  2. Use the quick tour or Skip, then open the full Crops walkthrough on the Playground page if you want every step spelled out.
  3. On Data, pick Starter apps → Crops.
  4. Turn Editing on.
  5. Plant wheat → wait ~5s on Screens → Ready to harvest.
  6. Harvest ready → confirm XP 10 on Players or XP board.
  7. Open Try it, then App menu → Share app (one file; open it with Open app file elsewhere).

Pattern: Data holds lists → actions change them → Screens update.

Local (optional):

bash
cd clients/studio && npm install && npm run build:wasm && npm run dev:playground
# open http://127.0.0.1:5173/?local=1

Full walkthrough, field-type chart, and build-your-own outline: Playground.

Path B — eelden run with examples

Open (or create) a local database directory, apply a schema, execute query files, print rows:

bash
cargo run -p eelden-cli -- run ./mydb examples/demo_schema.eel examples/demo_queries.eel

demo_queries.eel inserts sample users, then filters and selects. Schema is examples/demo_schema.eel (Users with Money, enums, @index on email).

More sample language: examples/storefront.eel, named queries under examples/queries/. See Examples.

Path C — Studio (serve-backed)

Studio is a Vue UI over eelden serve. It never opens page files itself.

HMR (API on :8787, UI on :5173):

bash
cd clients/studio && npm run dev

CLI serves a built dist and opens the browser:

bash
cd clients/studio && npm run build:wasm && npm run build && cd ../..
cargo run -p eelden-cli -- studio ./mydb-studio examples/demo_schema.eel --ui clients/studio/dist

The URL includes a bearer token. Use the Examples rail for runnable demos; toggle Write mode before mutations.

Details: Studio.

Path D — Named queries + TypeScript codegen

Named .eel files are the primary app surface (sqlc-like). From clients/typescript:

bash
cd clients/typescript && npm install && npm run build
node bin/eelden-codegen.mjs --config ../../examples/eelden.config.json

Config (examples/eelden.config.json) points at demo_schema.eel and queries/**/*.eel, and writes under outDir.

Typecheck named queries without codegen:

bash
cargo run -p eelden-cli -- typecheck-queries examples/demo_schema.eel examples/queries/users.eel

Details: Named queries and TypeScript client.

Where next

Pre-alpha. Local-first. Stdlib-only Rust engine. Tenant concerns shifted left into the database.