Skip to content

Sunpeak-AI/sunpeak

Repository files navigation

sunpeak

npm version npm downloads CI License TypeScript React

The MCP App SDK.

Quickstart, build, and test your ChatGPT App locally with OpenAI apps-sdk-ui React components.

Documentation

Quickstart

New Projects

Requirements: Node (20+), pnpm (10+)

pnpm dlx sunpeak new

To add sunpeak to an existing project, refer to the documentation.

Key Features

Example Component

import './styles/globals.css';
import { Card } from './components/card';

export default function App() {
  return (
    <Card
      image="https://images.unsplash.com/photo-1520950237264-dfe336995c34?w=400&h=400&fit=crop"
      imageAlt="Lady Bird Lake"
      header="Lady Bird Lake"
      metadata="⭐ 4.5 • Austin, TX"
      button1={{ children: 'Visit', isPrimary: true, onClick: () => {} }}
      button2={{ children: 'Learn More', onClick: () => {} }}
    >
      Scenic lake perfect for kayaking, paddleboarding, and trails.
    </Card>
  );
}

What is sunpeak exactly?

sunpeak is an npm package consisting of:

  1. A CLI utility for working with sunpeak (./bin).
  2. A templated npm package (./template). This template includes:
    1. Project scaffold - Complete development setup with build, test, and dev tooling.
    2. Pre-built UI components - Production-ready components following ChatGPT design guidelines.
  3. The sunpeak library (./src). This library contains:
    1. Multi-platform APIs - Abstraction layer for future platform support (Gemini, Claude).
    2. ChatGPT simulator - Local development environment replicating ChatGPT's widget runtime.
    3. MCP server - View local widgets in the real ChatGPT.

Contributing

We welcome your contributions!

For development quickstart on this package, see DEVELOPMENT.md.

Resources