mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Jordan Ritter
fd34bbfbf6
Run prettier on ~1,865 files across examples/ to match the monorepo's formatting standards. These files were imported as-is from standalone repos that used different prettier configs.
108 lines
3.0 KiB
Markdown
108 lines
3.0 KiB
Markdown
# CopilotKit <> CrewAI Flow Starter
|
|
|
|
This is a starter template for building AI agents using [CrewAI Flows](https://docs.crewai.com/en/concepts/flows) and [CopilotKit](https://copilotkit.ai). It provides a modern Next.js application with an integrated CrewAI Flow agent to be built on top of.
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js 18+
|
|
- Python 3.8+
|
|
- Any of the following package managers:
|
|
- [pnpm](https://pnpm.io/installation) (recommended)
|
|
- npm
|
|
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable)
|
|
- [bun](https://bun.sh/)
|
|
- OpenAI API Key (for the CrewAI Flow agent)
|
|
|
|
> **Note:** This repository ignores lock files (package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb) to avoid conflicts between different package managers. Each developer should generate their own lock file using their preferred package manager. After that, make sure to delete it from the .gitignore.
|
|
|
|
## Getting Started
|
|
|
|
1. Install dependencies using your preferred package manager:
|
|
|
|
```bash
|
|
# Using pnpm (recommended)
|
|
pnpm install
|
|
|
|
# Using npm
|
|
npm 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.
|
|
|
|
2. Set up your OpenAI API key:
|
|
|
|
```bash
|
|
cd agent
|
|
echo "OPENAI_API_KEY=your-openai-api-key-here" > .env
|
|
```
|
|
|
|
3. Start the development server:
|
|
|
|
```bash
|
|
# Using pnpm (recommended)
|
|
pnpm dev
|
|
|
|
# Using npm
|
|
npm run 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 CrewAI Flow 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 interactin with CrewAI Flow
|
|
|
|
## 📚 Documentation
|
|
|
|
- [CopilotKit Documentation](https://docs.copilotkit.ai) - Explore CopilotKit's capabilities
|
|
- [CrewAI Flow Documentation](https://docs.crewai.com/en/concepts/flows) - Learn more about CrewAI Flow and its features
|
|
- [Next.js Documentation](https://nextjs.org/docs) - 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:
|
|
|
|
1. The CrewAI Flow agent is running on port 8000
|
|
2. Your OpenAI API key is set correctly
|
|
3. Both servers started successfully
|