-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2a58389
commit 23523b9
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## Overview | ||
|
||
A Next.js frontend for a simple AI voice assistant using LiveKit's official [React Components](https://github.com/livekit/components-js/) library and styled with TailwindCSS. The application implements its own token server, and is designed to be used with any voice-enabled agent built using our [Agents Framework](https://docs.livekit.io/agents/). | ||
|
||
## Sandbox | ||
|
||
When deployed in a sandbox, LiveKit will host an instance of this application for you, providing a unique, shareable URL through which you can access it. Any agents running with the same LiveKit project credentials will join, meaning that you can rapidly iterate on your agent prototypes, and share the results instantly with friends and colleagues. To begin testing your agent, deploy this app in sandbox then set up an agent on your local machine using the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup/): | ||
|
||
```console | ||
lk app create --template voice-pipeline-agent-python | ||
``` | ||
|
||
**NOTE:** For a list of all available templates, run `lk app create` with no arguments. | ||
|
||
|
||
## Installation | ||
|
||
To run this application locally, clone the repo or use the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup/): | ||
|
||
```console | ||
lk app create --template voice-assistant-frontend | ||
``` | ||
|
||
For more information on prototyping using LiveKit Sandbox, see the [documentation](https://docs.livekit.io/home/cloud/sandbox/). |