Skip to content

getting-started.md

Latest commit

 

History

History
71 lines (51 loc) · 1.84 KB

getting-started.md

File metadata and controls

71 lines (51 loc) · 1.84 KB

Getting Started

Clone and Install

git clone https://github.com/CopilotKit/OpenGenerativeUI.git
cd OpenGenerativeUI

# Install all dependencies and create .env
make setup

make setup runs pnpm install and creates apps/agent/.env if it doesn't exist.

Configure Environment

Add your OpenAI API key to apps/agent/.env:

OPENAI_API_KEY=sk-...

You can also set these optional variables in the root .env:

Variable Default Description
LLM_MODEL gpt-5.4-2026-03-05 LLM model for the agent
RATE_LIMIT_ENABLED false Enable per-IP rate limiting
RATE_LIMIT_WINDOW_MS 60000 Rate limit window (ms)
RATE_LIMIT_MAX 40 Max requests per window
MCP_SERVER_URL — Optional MCP server URL

Run the Project

# Start all services (frontend + agent)
make dev

This starts:

You can also start services individually:

make dev-app     # Frontend only
make dev-agent   # Agent only
make dev-mcp     # MCP server only

Verify It Works

  1. Open http://localhost:3000
  2. You should see the Open Generative UI chat interface
  3. Try typing "Create a todo list for a weekend project" or click one of the demo suggestions
  4. The agent should respond and you'll see generative UI rendered in the chat

Project Scripts

make build   # Build all apps
make lint    # Lint all apps
make clean   # Clean build artifacts
make help    # Show all available commands

Next Steps