Run the example app

Neon Kicks is the example app in the repository. It has two screens worth knowing about: a scripted shop with five registered actions covering every risk level, and a component gallery that draws every catalog block from fixtures.

The gallery is the fastest way to see what this product actually renders. It is completely offline — no API, no key, no model — so it runs the moment the package resolves.

git clone https://github.com/neon-apps/rendel-flutter.git
cd rendel-flutter/example
flutter run

Needs Flutter 3.29 / Dart 3.7 or later. The example ships an iOS runner only: for Android, run flutter create --platforms=android . in example/ first, and build with JDK 21.

Open the gallery from the app bar. Every block is drawn by the real renderer through ComponentRegistry.build, the same path a live answer takes, so what you are looking at is what an answer page shows.

The token switch

The gallery's app bar toggles between RendelTheme.paper() and RendelTheme.deep(), Rendel's own light and dark palettes. The copilot follows the device's dark mode unless you set themeMode, so look at both before you map your own. See Dark mode.

Talking to a real copilot

The shop screen needs a key and an API. Point it at your own app with two defines:

flutter run \
  --dart-define=RENDEL_KEY=rd_pk_test_yourapp_... \
  --dart-define=RENDEL_API=https://api.rendel.ai

Without them it defaults to a local seed key against http://localhost:3200, which only resolves against a stack you are running yourself.