ContextQMD
Back to Tldraw

README

templates/chat/README.md

4.5.113.3 KB
Original Source
<div alt style="text-align: center; transform: scale(.5);"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tldraw/tldraw/main/assets/github-hero-dark.png" /> 
</picture>
</div>

This repo contains a starter-kit for making an AI chat application using tldraw.

Local development

Install dependencies with yarn or npm install.

Run the development server with yarn dev or npm run dev.

Open http://localhost:3000/ in your browser to see the app.

This starter kit demonstrates how to build an AI chat application that uses tldraw to provide sketches and annotated image to the model. The app features:

  • Integrated whiteboard for providing visual context
  • Image annotation and markup
  • Easy switching between text chat and visual canvas input

Key interactions include:

  • Chat with AI using natural language
  • Click the whiteboard button to open the tldraw canvas
  • Draw, sketch, and create diagrams to supplement conversations
  • Annotate images and visual content directly on the canvas

Environment setup

Create a .env.local file in the root directory and add your Google Generative API key:

GOOGLE_GENERATIVE_AI_API_KEY=your_gemini_api_key_here

Get your API key from Google AI Studio. You can also switch to a different provider using the Vercel AI SDK.

File structure

  • src/app/page.tsx: The main entry point that renders the chat interface
  • src/components/Chat.tsx: The main chat container using the Vercel AI SDK's useChat hook
  • src/components/MessageList.tsx: Scrollable message history with loading states
  • src/components/ChatMessage.tsx: Individual message display component
  • src/components/ChatInput.tsx: Input field with send functionality
  • src/components/WhiteboardModal.tsx: Modal component that integrates tldraw for drawing and sketching
  • src/app/api/chat/route.ts: Next.js API route using Vercel AI SDK for OpenAI integration
  • src/app/styles.css: CSS with responsive design for all components

License

This project is provided under the MIT license found here. The tldraw SDK is provided under the tldraw license.

Trademarks

Copyright (c) 2024-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our trademark guidelines for info on acceptable usage.

Distributions

You can find tldraw on npm here.

Contribution

Please see our contributing guide. Found a bug? Please submit an issue.

Community

Have questions, comments or feedback? Join our discord. For the latest news and release notes, visit tldraw.dev.

Contact

Find us on Twitter/X at @tldraw.