mirror of https://github.com/CopilotKit/CopilotKit.git synced 2026-09-14 16:26:20 +08:00

Files

T

Alem Tuzlak 41e57ed74b fix: remove .bat fallback pattern, fix README typos and phantom scripts

- Remove '|| .bat' fallback from all starter package.json scripts so
  real errors on Linux/macOS are not masked by a failing .bat attempt
- Fix typos: 'isseus' -> 'issues', 'interactin' -> 'interacting'
- Fix crewai-crews README title/body saying 'Flow' instead of 'Crew'
- Fix a2a-a2ui README wrong agent name and file path
- Remove phantom lint/dev:debug scripts from README Available Scripts
  sections where those scripts don't exist in package.json
- Add missing dev:ui and dev:agent to mastra README

2026-04-16 14:00:52 +02:00

2.9 KiB

Raw Permalink Blame History

CopilotKit <> LangGraph Starter

This is a starter template for building AI agents using LangGraph and CopilotKit. It provides a modern Next.js application with an integrated LangGraph agent to be built on top of.

Prerequisites

Node.js 18+
Python 3.8+
Poetry 2+
Any of the following package managers:
- npm (default)
- pnpm
- yarn
- bun
OpenAI API Key (for the LangGraph agent)

Getting Started

Install dependencies using your preferred package manager:

# Using npm (default)
npm install

# Using pnpm
pnpm install

# Using yarn
yarn install

# Using bun
bun install

Install Python dependencies for the LangGraph agent:

# Using npm (default)
npm run install:agent

# Using pnpm
pnpm install:agent

# Using yarn
yarn install:agent

# Using bun
bun run install:agent

Set up your OpenAI API key:

echo 'OPENAI_API_KEY=your-openai-api-key-here' > agent/.env

Start the development server:

# Using npm (default)
npm run dev

# Using pnpm
pnpm dev

# Using yarn
yarn dev

# Using bun
bun run dev

This will start both the UI and agent servers concurrently.

Available Scripts

The following scripts can also be run using your preferred package manager:

dev - Starts both UI and agent servers in development mode
dev:debug - Starts development servers with debug logging enabled
dev:ui - Starts only the Next.js UI server
dev:agent - Starts only the LangGraph agent server
build - Builds the Next.js application for production
start - Starts the production server
install:agent - Installs Python dependencies for the agent

Documentation

The main UI component is in src/app/page.tsx. You can:

Modify the theme colors and styling
Add new frontend actions
Customize the CopilotKit sidebar appearance

📚 Documentation

LangGraph Documentation - Learn more about LangGraph and its features
CopilotKit Documentation - Explore CopilotKit's capabilities
Next.js Documentation - Learn about Next.js features and API
YFinance Documentation - Financial data tools

Contributing

Feel free to submit issues and enhancement requests! This starter is designed to be easily extensible.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Troubleshooting

Agent Connection Issues

If you see "I'm having trouble connecting to my tools", make sure:

The LangGraph agent is running on port 8000
Your OpenAI API key is set correctly
Both servers started successfully

Python Dependencies

If you encounter Python import errors:

cd agent
poetry lock && poetry install

2.9 KiB Raw Permalink Blame History