The Open Standard for Generative UI
Add README for the Vue chat example (#558)
Md Mushfiqur Rahim485a7d1caa93
diff --git a/examples/vue-chat/README.md b/examples/vue-chat/README.mdnew file mode 100644index 000000000..631604a69--- /dev/null+++ b/examples/vue-chat/README.md@@ -0,0 +1,94 @@+# OpenUI Vue Chat++A chat application built with [Nuxt 3](https://nuxt.com), [Vercel AI SDK](https://ai-sdk.dev), and [`@openuidev/vue-lang`](../../packages/vue-lang/) — demonstrating how to render structured LLM output as live Vue components.++## How it works++1. **User sends a message** via the chat input+2. **Server streams a response** using the Vercel AI SDK with OpenAI, guided by a system prompt written in openui-lang syntax+3. **`@openuidev/vue-lang` Renderer** parses the streaming openui-lang text and renders it as Vue components in real time+4. **Tool calls** (weather, stocks, math, web search) are displayed inline with status indicators++## Setup++### Prerequisites++- Node.js 18++- [pnpm](https://pnpm.io/)+- An OpenAI API key++### Install dependencies++From the monorepo root:++```bash+pnpm install+```++### Configure environment++```bash+cp .env.example .env+```++Edit `.env` and add your OpenAI API key:++```+OPENAI_API_KEY=sk-...+```++### Generate the system prompt (optional)++```bash+pnpm --filter vue-chat generate:prompt+```++The generated prompt lives at `generated/system-prompt.txt` and is checked in, so this step is only needed after modifying component definitions in `lib/library.ts`.++### Run++```bash+pnpm --filter vue-chat dev+```++Open [http://localhost:3000](http://localhost:3000).++## Project structure++```+app.vue # Root component (renders NuxtPage)+nuxt.config.ts # Nuxt config (ssr: false, Tailwind CSS, Nitro bundling)+pages/+└── index.vue # Chat UI with AI SDK Chat class + OpenUI Renderer+components/+├── ChatHeader.vue # Top bar with title+├── ChatInput.vue # Message input + send/stop buttons+├── UserMessage.vue # Renders user message parts+├── AssistantMessage.vue # Renders assistant message with OpenUI Renderer+├── LoadingIndicator.vue # Animated loading dots+├── WelcomeScreen.vue # Start page with example prompts+└── openui/ # Vue component renderers for openui-lang output+ ├── Stack.vue+ ├── Card.vue+ ├── TextContent.vue+ ├── Button.vue+ └── Chart.vue+lib/+├── library.ts # OpenUI component definitions (Stack, Card, TextContent, Button, Chart)+└── tools.ts # AI tool definitions (weather, stocks, math, search)+server/+└── api/chat.post.ts # AI SDK streaming endpoint+generated/+└── system-prompt.txt # LLM system prompt describing the openui-lang syntax+assets/+└── app.css # Tailwind CSS entry point+```++## Adding components++1. Create a Vue component in `components/openui/`+2. Define it with `defineComponent()` in `lib/library.ts`+3. Run `pnpm --filter vue-chat generate:prompt` to update `generated/system-prompt.txt`+4. Commit the updated prompt file++See the [`@openuidev/vue-lang` README](../../packages/vue-lang/README.md) for the full API.