Skip to content

CopilotKit/frenchfry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Frenchfry

Frenchfry is a strongly-typed, reactive runtime and UI integration stack for building realtime voice + tool-driven applications on top of the OpenAI Realtime API over WebRTC.

Warning

This project is entirely experimental and is not officially supported. APIs, behavior, and package boundaries may change without notice.

What It Does

  • Provides framework-agnostic client primitives for browser-side Realtime session handling.
  • Provides a server runtime boundary for OpenAI connectivity and API-key injection.
  • Provides React bindings for voice agents and outlet-based generative UI rendering.
  • Demonstrates end-to-end usage with local demo app and demo server packages.

Repository Layout

packages/
  core/       framework-agnostic frontend connection logic (no UI rendering)
  react/      React bindings built on top of core and Hashbrown UI patterns
  runtime/    server runtime/proxy to OpenAI (including API-key injection boundary)
demos/
  app/        demo React application
  server/     demo server

Packages

  • @frenchfryai/core
    • Typed Realtime client lifecycle
    • Runtime-validated protocol parsing
    • Tool-call accumulation and execution helpers
  • @frenchfryai/react
    • VoiceAgent orchestration component
    • FrenchfryProvider, VoiceUiOutlet, and useGenUi
  • @frenchfryai/runtime
    • Typed route registration for Realtime session exchange
    • Validation of external request payloads

Quickstart

npm install
npm run demo:dev

Create a local .env file with your OpenAI credentials and runtime settings before starting demos.

Quality Gates

npm run lint
npm run format:check
npm run typecheck
npm run test -- --coverage
npm run build

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors