Skip to content

Commit

Permalink
Merge pull request #3 from flo-bit/main
Browse files Browse the repository at this point in the history
deploy
  • Loading branch information
flo-bit authored Oct 5, 2024
2 parents 042e6b6 + 3357350 commit 272897b
Show file tree
Hide file tree
Showing 16 changed files with 1,157 additions and 152 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# sveltekit openai realtime api

this is a sveltekit port of the [openai-realtime-console](https://github.com/openai/openai-realtime-console) repository.
this is a svelte component for using the openai realtime api (and mostly a direct port to svelte of the [openai-realtime-console](https://github.com/openai/openai-realtime-console) repository).

it allows you to easily use the openai realtime api in your sveltekit project.
it allows you to easily use the openai realtime api in your svelte(kit) project.

work in progress, but it should be functional.

demo here (enter your own api key, as always be careful with stuff like that and e.g. use a 2$ limited api key): https://flo-bit.dev/svelte-openai-realtime-api/

https://github.com/user-attachments/assets/c1e96dac-98b5-4e16-95e8-9cbc6e60865d

## how to use

> [!WARNING]
Expand Down Expand Up @@ -115,11 +119,29 @@ $ node relay-server/index.js

## todos

- [x] show waveforms
- [ ] add tests
- [ ] update main demo ui
- [ ] add more documentation
- [ ] show waveforms
- [ ] simple setup client side, server side
- [ ] all props
- [ ] tool calling
- [ ] update ui
- [ ] events
- onConnect
- onDisconnect
- onError
- onInterrupt
- onRealtimeEvent
- onConversationUpdate
- speechStart
- speechStop
- [ ] error handling
- [ ] pause/resume recording
- [ ] send text message
- [ ] update props
- instructions
- voice
- vad settings

## license

Expand Down
Loading

0 comments on commit 272897b

Please sign in to comment.