wehub-resource-sync
81 lines
1.9 KiB
Markdown
81 lines
1.9 KiB
Markdown
# CopilotKit <> Mastra Starter
|
|
|
|
This is a starter template for building AI agents using [Mastra](https://mastra.ai) and [CopilotKit](https://copilotkit.ai). It provides a modern Next.js application with integrated AI capabilities and a beautiful UI.
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js 18+
|
|
- Any of the following package managers:
|
|
- npm (default)
|
|
- [pnpm](https://pnpm.io/installation)
|
|
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/)
|
|
- [bun](https://bun.sh/)
|
|
|
|
## Getting Started
|
|
|
|
1. Add your OpenAI API key
|
|
|
|
```bash
|
|
# you can use whatever model Mastra supports
|
|
echo "OPENAI_API_KEY=your-key-here" >> .env
|
|
```
|
|
|
|
2. Install dependencies using your preferred package manager:
|
|
|
|
```bash
|
|
# Using npm (default)
|
|
npm install
|
|
|
|
# Using pnpm
|
|
pnpm install
|
|
|
|
# Using yarn
|
|
yarn install
|
|
|
|
# Using bun
|
|
bun install
|
|
```
|
|
|
|
3. Start the development server:
|
|
|
|
```bash
|
|
# 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 Mastra agent server
|
|
- `dev:debug` - Starts development servers with debug logging enabled
|
|
- `build` - Builds the application for production
|
|
- `start` - Starts the production server
|
|
|
|
## Documentation
|
|
|
|
- [Mastra Documentation](https://mastra.ai/en/docs) - Learn more about Mastra and its features
|
|
- [CopilotKit Documentation](https://docs.copilotkit.ai) - Explore CopilotKit's capabilities
|
|
- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API
|
|
|
|
## Contributing
|
|
|
|
Feel free to submit issues and enhancement requests!
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the LICENSE file for details.
|