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

Prerequisites

Node.js 18+
Python 3.8+
Any of the following package managers:
- npm (default)
- pnpm
- yarn
- bun
OpenAI API Key (for the CrewAI Crew 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

Note: Installing the package dependencies will also install the agent's python dependencies via the install:agent script.

Set up your OpenAI API key:

cd agent
echo "OPENAI_API_KEY=your-openai-api-key-here" > .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:ui - Starts only the Next.js UI server
dev:agent - Starts only the CrewAI Crew agent server
build - Builds the Next.js application for production
start - Starts the production server
lint - Runs ESLint for code linting
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
Utilize shared-state
Customize your user-interface for interacting with CrewAI Crews

📚 Documentation

CopilotKit Documentation - Explore CopilotKit's capabilities
CrewAI Crews Documentation - Learn more about CrewAI Crews and its features
Next.js Documentation - Learn about Next.js features and API

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 CrewAI Crew agent is running on port 8000
Your OpenAI API key is set correctly
Both servers started successfully