Start from an example

Clone a working starter and run it on your own tenant in minutes — a reference App and a reference Theme, both deployed with the revenexx CLI.

Clone & run

Sample App

A minimal App — a greetings entity with full CRUD over the gateway. The shortest path to a live capability.

Sample Theme

A minimal Blökkli storefront theme — a Nuxt SSR site you can deploy and reach on a preview domain.

The fastest way to understand the platform is to run something real on your own tenant. Each starter below clones, installs, and deploys with the revenexx CLI in a few commands. Prerequisites: the CLI installed, a tenant slug and an X-Revenexx-Api-Key (create an API key). The repository URLs and CLI flags below were last checked in 2026-09; if one fails, the linked reference pages are current.

Sample App

revenexx/sample-app is a reference App: a greetings entity exposed as a small REST surface (create, list, get, update, delete, plus a digest transform) built on @revenexx/app-sdk. It's the end-to-end loop — manifest → register → deploy → call — in its smallest form.

Clone & deploy

git clone https://github.com/revenexx/sample-app.git
cd sample-app
npm install

revenexx login --token <API_KEY> --tenant <TENANT_SLUG>
revenexx deploy app

revenexx deploy app registers the App if it is new, then uploads, builds, publishes and installs it. Then call it through the gateway — the key must hold a scope covering the capability (e.g. greetings.*):

Call it

curl "https://api.revenexx.com/v1/greetings?limit=20&order=created_at.desc" \
  -H "X-Revenexx-Tenant: <TENANT_SLUG>" \
  -H "X-Revenexx-Api-Key: rvxk_..."

Walk through how it is built in Build your first App.

Sample Theme

revenexx/sample-theme is a reference Theme: a Nuxt SSR site plus the Blökkli contract. Clone and run it here. Build your first Theme owns the walkthrough of its manifest, deploy and activation.

Clone & run

git clone https://github.com/revenexx/sample-theme.git
cd sample-theme
npm install
npm run dev

npm run dev previews it locally. To deploy it, run revenexx deploy theme . from the directory, or use the step-by-step revenexx sites commands. Create the site first in Cockpit or with revenexx sites create, then find its id with revenexx sites list:

Deploy

revenexx login --token <API_KEY> --tenant <TENANT_SLUG>
revenexx sites create-deployment --site-id <SITE_ID> --activate true --code .

For a site connected to a Git repository, push to deploy instead. See Deploy from CLI and Deploy from Git.

Both starters are kept minimal on purpose — they prove the contract end to end so you can graduate to the full App and Theme guides with a working starting point.