Skip to content

Getting Started

Chalk is an ultra low-latency video conferencing SDK built on Cloudflare RealtimeKit, designed for education.

Overview

Chalk provides a React SDK with turnkey components and hooks for building video conferencing experiences.

Prerequisites

Node.js 18+ or Bun
A Chalk API key (contact sales@q9labs.ai)

Quick Start

bun add @q9labs/chalk-react

import { ChalkProvider, VideoConference } from '@q9labs/chalk-react'
import '@q9labs/chalk-react/styles.css'

function App() {
  return (
    <ChalkProvider apiUrl="https://api.chalk.q9labs.ai" token={jwt}>
      <VideoConference
        roomId="room-123"
        userName="Alice"
        role="host"
      />
    </ChalkProvider>
  )
}

Next Steps