https://github.com/copilotkit/with-langgraph-js
https://github.com/copilotkit/with-langgraph-js
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/copilotkit/with-langgraph-js
- Owner: CopilotKit
- License: mit
- Created: 2025-06-23T00:16:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-07-03T18:40:14.000Z (6 months ago)
- Last Synced: 2025-07-03T18:42:35.254Z (6 months ago)
- Language: TypeScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CopilotKit <> LangGraph Starter
This is a starter template for building AI agents using [LangGraph](https://www.langchain.com/langgraph) and [CopilotKit](https://copilotkit.ai). 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+
- 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 LangGraph 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
```
2. Install dependencies for the LangGraph agent:
```bash
cd agent
```
```bash
# Using pnpm (recommended)
pnpm install
# Using npm
npm run install
# Using yarn
yarn install
# Using bun
bun run install
```
3. Set up your OpenAI API key:
```bash
cd agent
echo "OPENAI_API_KEY=your-openai-api-key-here" > .env
```
4. 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:studio` - Starts the UI and agent with LangGraph Studio
- `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
- `dev:agent:studio` - Starts the LangGraph agent server with LangGraph Studio
- `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 LangGraph
## 📚 Documentation
- [CopilotKit Documentation](https://docs.copilotkit.ai) - Explore CopilotKit's capabilities
- [LangGraph Documentation](https://langchain-ai.github.io/langgraph/) - Learn more about LangGraph 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 LangGraph agent is running on port 8000
2. Your OpenAI API key is set correctly
3. Both servers started successfully