Back to Copilotkit

CopilotKit + ADK Generative Canvas

examples/showcases/adk-dashboard/README.md

1.57.02.1 KB
Original Source

CopilotKit + ADK Generative Canvas

https://github.com/user-attachments/assets/9201d528-573f-43cc-9d31-571c362318a7


This project provides a Canvas UI for building and running agents with Google’s ADK, AG-UI, and CopilotKit.

Instead of plain text, the agent can populate metrics, charts, and real-time data into the Canvas dashboard.


πŸ”§ Quickstart

bash
git clone https://github.com/your-org/copilotkit-adk-canvas
cd copilotkit-adk-canvas

# install JS deps + agent
pnpm install        # or npm/yarn/bun

# install Python deps separately for the ADK agent
pnpm install:agent

# set your Google API key
export GOOGLE_API_KEY="your-google-api-key-here"

# start UI + agent together
pnpm run dev

πŸ“¦ Prerequisites

  • Node.js 18+
  • Python 3.8+
  • Google Makersuite API Key β†’ get one here
  • Any package manager (pnpm recommended)

πŸ’‘ Lockfiles (package-lock.json, yarn.lock, etc.) are gitignored β€” each dev manages their own.


πŸ›  Available Scripts

  • dev β†’ Start UI + agent (default)
  • dev:debug β†’ Start with debug logging
  • dev:ui β†’ Run just the Next.js app
  • dev:agent β†’ Run just the ADK agent
  • build / start β†’ Production build + server
  • lint β†’ Run ESLint
  • install:agent β†’ Install Python deps inside agent/.venv

🎨 Customization

  • Main UI β†’ src/app/page.tsx
  • Change theme/colors and sidebar appearance
  • Add new visualization components
  • Extend agent logic in /agent

πŸ“š Docs


πŸ› Troubleshooting

Agent connection issues?

  • Ensure ADK agent runs on port 8000
  • Double-check GOOGLE_API_KEY
  • Confirm both servers boot without errors

🀝 Contributing

PRs and issues welcome β€” this Canvas is meant to be hacked on.


πŸ“„ License

MIT β€” see LICENSE for details.