Skip to content

Commit 01bac18

Browse files
authored
Merge pull request #22 from rahulbsw/docs/readme-demo-showcase
docs: Add UI demo to README landing page
2 parents 4ca7a6a + 2dcc738 commit 01bac18

6 files changed

Lines changed: 70 additions & 4 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,23 @@
1313

1414
StreamForge helps data teams move only the records and fields downstream systems actually need. Instead of mirroring whole topics, StreamForge lets you filter, reshape, redact, and route messages before they land in analytics, lake, or lower-trust environments.
1515

16-
**[5-Minute Demo](#5-minute-demo)** | **[When to Use StreamForge](#when-to-use-streamforge)** | **[Compatibility](#compatibility)** | **[Documentation Index](docs/DOCUMENTATION_INDEX.md)**
17-
18-
---
19-
2016
## Why Teams Use StreamForge
2117

2218
- Replicate only analytics-safe fields instead of whole topics
2319
- Split one source topic into multiple downstream topics
2420
- Hash or drop PII before data crosses trust boundaries
2521
- Keep the deployment surface small with a single binary, operator, and Helm chart
2622

23+
## Watch StreamForge Deploy on Minikube
24+
25+
[![StreamForge UI demo on Minikube](docs/assets/demo/ui-minikube-demo-readme.gif)](docs/UI_MINIKUBE_DEMO.md)
26+
27+
This UI-driven demo shows the path most teams actually want to see first: install with Helm, create a pipeline in the browser, review the generated YAML, deploy the CRD, then verify transformed output on Kafka.
28+
29+
**[UI Demo](docs/UI_MINIKUBE_DEMO.md)** | **[5-Minute CLI Demo](#5-minute-demo)** | **[Examples](examples/README.md)** | **[Compatibility](#compatibility)** | **[Documentation Index](docs/DOCUMENTATION_INDEX.md)**
30+
31+
---
32+
2733
## When to Use StreamForge
2834

2935
Use StreamForge when you need:
@@ -56,6 +62,8 @@ For concrete usage patterns and configs, see [docs/USAGE.md](docs/USAGE.md) and
5662
Leave StreamForge running in this terminal.
5763
4. Open a second terminal and follow [docs/QUICKSTART.md](docs/QUICKSTART.md) to create the demo topics, produce a sample order, and inspect `analytics-orders` and `pii-safe-orders`.
5864

65+
If you want the Kubernetes + UI path instead of the local CLI path, use [docs/UI_MINIKUBE_DEMO.md](docs/UI_MINIKUBE_DEMO.md).
66+
5967
## Production Trust Signals
6068

6169
- At-least-once delivery with retry and DLQ support

docs/KUBERNETES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,8 @@ helm upgrade streamforge-operator ./helm/streamforge-operator \
491491

492492
⚠️ **Change these in production!**
493493

494+
See [UI Demo on Minikube](UI_MINIKUBE_DEMO.md) for a full recorded walkthrough of the Helm install, UI pipeline creation, YAML preview, and transformed output verification.
495+
494496
**UI Configuration:**
495497

496498
```yaml

docs/UI_MINIKUBE_DEMO.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: UI Demo on Minikube
3+
nav_order: 3
4+
---
5+
6+
# UI Demo on Minikube
7+
8+
This walkthrough shows the public-facing StreamForge UI flow on a local Minikube cluster:
9+
10+
1. Install the operator and UI with Helm
11+
2. Open the UI and sign in
12+
3. Create a pipeline in form mode
13+
4. Show the generated YAML before deployment
14+
5. Deploy the CRD to Kubernetes
15+
6. Produce a sample event to Kafka
16+
7. Consume the transformed event from the analytics topic
17+
18+
<video controls preload="metadata" style="width:100%;max-width:1200px;border-radius:12px;">
19+
<source src="/streamforge/assets/demo/ui-minikube-demo.mp4" type="video/mp4">
20+
Your browser does not support embedded MP4 playback.
21+
</video>
22+
23+
If the embedded player does not load in your renderer, use the repo asset directly: [ui-minikube-demo.mp4](assets/demo/ui-minikube-demo.mp4)
24+
25+
## What the Demo Shows
26+
27+
- Helm install of the StreamForge operator with the built-in UI enabled
28+
- Login with the demo credentials `admin` / `admin`
29+
- Pipeline creation through the UI instead of hand-written YAML
30+
- YAML preview before create
31+
- Runtime verification with a produced input event and a consumed transformed output event
32+
33+
Expected transformed output:
34+
35+
```json
36+
{"amount":125,"order_id":"ord-ui-demo-1001","region":"us"}
37+
```
38+
39+
## Demo Topics
40+
41+
- Input topic: `raw-orders-ui-demo`
42+
- UI-declared destination topic: `mirror-orders-ui-demo`
43+
- Verified transformed output topic: `analytics-orders-ui-demo`
44+
45+
## Demo Note
46+
47+
This recording keeps the transformed verification on a dedicated analytics topic so the public walkthrough stays accurate while the current UI deployment flow still mirrors the first declared destination as a raw stream.
48+
49+
## Reproduce It
50+
51+
Use these docs for the same setup shown in the recording:
52+
53+
- [Kubernetes](KUBERNETES.md)
54+
- [Helm chart README](../helm/streamforge-operator/README.md)
55+
- [Examples](EXAMPLES.md)
817 KB
Loading
2.45 MB
Binary file not shown.

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ StreamForge helps data teams filter, transform, redact, and route records betwee
1212
## Get Started
1313

1414
- [Quickstart](QUICKSTART.md) - Run the five-minute selective replication demo
15+
- [UI Demo on Minikube](UI_MINIKUBE_DEMO.md) - Deploy with Helm, create a pipeline in the UI, and verify transformed output
1516
- [Examples](EXAMPLES.md) - Browse validated demo and production configs
1617

1718
## Build Pipelines

0 commit comments

Comments
 (0)