https://github.com/cedarcopilot/cedar-hackathon-starter
Cedar x Mastra starter for quick projects
https://github.com/cedarcopilot/cedar-hackathon-starter
Last synced: 8 months ago
JSON representation
Cedar x Mastra starter for quick projects
- Host: GitHub
- URL: https://github.com/cedarcopilot/cedar-hackathon-starter
- Owner: CedarCopilot
- Created: 2025-09-21T00:04:06.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-24T04:53:56.000Z (9 months ago)
- Last Synced: 2025-09-24T06:24:59.270Z (9 months ago)
- Language: TypeScript
- Size: 307 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cedar-OS + Mastra Starter Template
A blank starter template combining [Cedar-OS](https://cedar.ai) for the frontend AI interface and [Mastra](https://mastra.ai) for the backend agent orchestration.
## Features
- **🤖 AI Chat Integration**: Built-in chat workflows powered by OpenAI through Mastra agents
- **âš¡ Real-time Streaming**: Server-sent events (SSE) for streaming AI responses
- **🎨 Beautiful UI**: Cedar-OS components with 3D effects and modern design
- **🔧 Type-safe Workflows**: Mastra-based backend with full TypeScript support
- **📡 Dual API Modes**: Both streaming and non-streaming chat endpoints
## Quick Start
The fastest way to get started:
```bash
npx cedar-os-cli plant-seed
```
Then select this template when prompted. This will set up the entire project structure and dependencies automatically.
This template contains the Cedar chat connected to a mastra backend to demonstrate what endpoints need to be implemented.
For more details, see the [Cedar Getting Started Guide](https://docs.cedarcopilot.com/getting-started/getting-started).
## Manual Setup
### Prerequisites
- Node.js 18+
- OpenAI API key
- pnpm (recommended) or npm
### Installation
1. **Clone and install dependencies:**
```bash
git clone
cd cedar-mastra-starter
pnpm install && cd src/backend && pnpm install && cd ../..
```
2. **Set up environment variables:**
Create a `.env` file in the root directory:
```env
OPENAI_API_KEY=your-openai-api-key-here
```
3. **Start the development servers:**
```bash
npm run dev
```
This runs both the Next.js frontend and Mastra backend concurrently:
- Frontend: http://localhost:3000
- Backend API: http://localhost:4111
## Project Architecture
### Frontend (Next.js + Cedar-OS)
- **Simple Chat UI**: See Cedar OS components in action in a pre-configured chat interface
- **Cedar-OS Components**: Cedar-OS Components installed in shadcn style for local changes
- **Tailwind CSS, Typescript, NextJS**: Patterns you're used to in any NextJS project
### Backend (Mastra)
- **Chat Workflow**: Example of a Mastra workflow – a chained sequence of tasks including LLM calls
- **Streaming Utils**: Examples of streaming text, status updates, and objects like tool calls
- **API Routes**: Examples of registering endpoint handlers for interacting with the backend
## API Endpoints (Mastra backend)
### Non-streaming Chat
```bash
POST /chat/execute-function
Content-Type: application/json
{
"prompt": "Hello, how can you help me?",
"temperature": 0.7,
"maxTokens": 1000,
"systemPrompt": "You are a helpful assistant."
}
```
### Streaming Chat
```bash
POST /chat/execute-function/stream
Content-Type: application/json
{
"prompt": "Tell me a story",
"temperature": 0.7
}
```
Returns Server-Sent Events with:
- **JSON Objects**: `{ type: 'stage_update', status: 'update_begin', message: 'Generating response...'}`
- **Text Chunks**: Streamed AI response text
- **Completion**: `event: done` signal
## Development
### Running the Project
```bash
# Start both frontend and backend
npm run dev
# Run frontend only
npm run dev:next
# Run backend only
npm run dev:mastra
```
## Learn More
- [Cedar-OS Documentation](https://docs.cedarcopilot.com/)
- [Mastra Documentation](https://mastra.ai/docs)
- [Next.js Documentation](https://nextjs.org/docs)
## License
MIT License - see LICENSE file for details.