Skip to content

Commit 341ee58

Browse files
create-rezi: flagship polished dashboard template + dashboard-only scaffolding (#95)
* create-rezi: ship flagship dashboard template and retire legacy starters * create-rezi: apply biome formatting for lint CI * create-rezi: keep __APP_NAME__ substitution in dashboard template * ci(docs): scope concurrency by ref to avoid cross-PR cancellations * create-rezi: defer dashboard stop to avoid reentrant handler shutdown
1 parent 8e624d5 commit 341ee58

28 files changed

Lines changed: 1350 additions & 2761 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permissions:
1212
id-token: write
1313

1414
concurrency:
15-
group: "pages"
15+
group: "pages-${{ github.ref }}"
1616
cancel-in-progress: true
1717

1818
jobs:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ cd my-app
4747
bun start
4848
```
4949

50-
Four starter templates: `dashboard`, `form-app`, `file-browser`, `streaming-viewer`.
50+
Starter template (current): `dashboard` (EdgeOps control-plane console).
5151

5252
## Example
5353

docs/getting-started/create-rezi.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,8 @@ bun run start
2020

2121
If `--template` is omitted, the CLI prompts you to choose (default: `dashboard`).
2222

23-
- `dashboard`: Live ops dashboard with deterministic table updates.
24-
Highlights: live-updating table with stable row keys, filter/sort/pin controls + incident telemetry.
25-
- `form-app`: Multi-step form with validation and command modes.
26-
Highlights: insert/command key modes with chords, modal help and toast notifications.
27-
- `file-browser`: Explorer with async command palette search.
28-
Highlights: async palette results with cancellation, table browser with details and preview.
29-
- `streaming-viewer`: High-volume stream monitor with virtualized index.
30-
Highlights: virtual list over 15k streams, live ingest feed with follow/pause controls.
23+
- `dashboard`: Product-grade EdgeOps console with deterministic live updates.
24+
Highlights: fleet services table, service inspector, active events feed, and escalation runbook.
3125

3226
Choose directly with `--template`:
3327

@@ -43,7 +37,7 @@ npm create rezi -- --list-templates
4337

4438
## Options
4539

46-
- `--template, -t <dashboard|form-app|file-browser|streaming-viewer>`: Select a template.
40+
- `--template, -t <dashboard>`: Select a template.
4741
- `--no-install, --skip-install`: Skip dependency installation.
4842
- `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
4943
- `--list-templates, --templates`: Print available templates and highlights.

docs/getting-started/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ node examples/raw-draw-demo/dist/index.js
2929

3030
## Looking for Larger App Examples?
3131

32-
Use `create-rezi` templates (`dashboard`, `form-app`, `file-browser`, `streaming-viewer`) for full multi-panel starter apps:
32+
Use the `create-rezi` dashboard template for a full multi-panel starter app:
3333

3434
- [Create Rezi (canonical template overview)](create-rezi.md)
3535
- [create-rezi package reference](../packages/create-rezi.md)

docs/getting-started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ cd my-tui-app
2020
bun start
2121
```
2222

23-
Select a template when prompted (dashboard, form-app, file-browser, or streaming-viewer), or pass `--template` to choose directly:
23+
Select the dashboard template when prompted, or pass `--template` to choose directly:
2424

2525
```bash
2626
npm create rezi my-tui-app -- --template dashboard

docs/packages/create-rezi.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ The CLI prompts for any missing values (project name/template) when run interact
2121
Canonical template names:
2222

2323
- `dashboard`
24-
- `form-app`
25-
- `file-browser`
26-
- `streaming-viewer`
2724

2825
Use a specific template:
2926

@@ -41,7 +38,7 @@ For template descriptions and highlights, use the canonical guide: [Getting Star
4138

4239
## Options
4340

44-
- `--template, -t <dashboard|form-app|file-browser|streaming-viewer>`: Select a template.
41+
- `--template, -t <dashboard>`: Select a template.
4542
- `--no-install, --skip-install`: Skip dependency installation.
4643
- `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
4744
- `--list-templates, --templates`: Print available templates and highlights.

docs/packages/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ npm install --save-dev @rezi-ui/testkit
108108

109109
**Project scaffolding CLI**
110110

111-
Generate a ready-to-run Rezi app with TypeScript configured and a multi-panel template:
111+
Generate a ready-to-run Rezi app with TypeScript configured and the polished dashboard template:
112112

113113
```bash
114114
npm create rezi my-app

packages/create-rezi/README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,12 @@ npm run start
1717

1818
## Templates
1919

20-
Choose a template interactively, or pass `--template` with a canonical name:
20+
Currently available template:
2121

22-
- `dashboard`
23-
- `form-app`
24-
- `file-browser`
25-
- `streaming-viewer`
22+
- `dashboard` - EdgeOps-style operations console starter
2623

2724
```bash
2825
npm create rezi my-app -- --template dashboard
29-
npm create rezi my-app -- --template form-app
30-
npm create rezi my-app -- --template file-browser
31-
npm create rezi my-app -- --template streaming-viewer
3226
```
3327

3428
List templates and highlights from the CLI:
@@ -39,7 +33,7 @@ npm create rezi -- --list-templates
3933

4034
## Options
4135

42-
- `--template, -t <dashboard|form-app|file-browser|streaming-viewer>`: Select a template.
36+
- `--template, -t <dashboard>`: Select a template.
4337
- `--no-install, --skip-install`: Skip dependency installation.
4438
- `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
4539
- `--list-templates, --templates`: Print available templates and highlights.

packages/create-rezi/src/__tests__/scaffold.test.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,11 @@ import {
1212

1313
test("normalizeTemplateName accepts friendly aliases", () => {
1414
assert.equal(normalizeTemplateName("dashboard"), "dashboard");
15-
assert.equal(normalizeTemplateName("form-app"), "form-app");
16-
assert.equal(normalizeTemplateName("form app"), "form-app");
17-
assert.equal(normalizeTemplateName("file-browser"), "file-browser");
18-
assert.equal(normalizeTemplateName("filebrowser"), "file-browser");
19-
assert.equal(normalizeTemplateName("streaming"), "streaming-viewer");
20-
assert.equal(normalizeTemplateName("streamingviewer"), "streaming-viewer");
15+
assert.equal(normalizeTemplateName("dash"), "dashboard");
2116
});
2217

2318
test("template keys match template directories and include highlights", async () => {
24-
const expectedKeys = ["dashboard", "form-app", "file-browser", "streaming-viewer"];
19+
const expectedKeys = ["dashboard"];
2520
const keys = TEMPLATE_DEFINITIONS.map((template) => template.key);
2621
assert.equal(keys.join(","), expectedKeys.join(","));
2722

packages/create-rezi/src/index.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,7 @@ function printHelp(): void {
8686
stdout.write("Usage:\n");
8787
stdout.write(" npm create rezi my-app\n\n");
8888
stdout.write("Options:\n");
89-
stdout.write(
90-
" --template, -t <name> dashboard | form-app | file-browser | streaming-viewer\n",
91-
);
89+
stdout.write(" --template, -t <name> dashboard\n");
9290
stdout.write(" --no-install Skip dependency install\n");
9391
stdout.write(" --pm <npm|pnpm|yarn|bun> Choose a package manager\n");
9492
stdout.write(" --list-templates Show templates and highlights\n");

0 commit comments

Comments
 (0)