From 23523b963817c84db7a4fb5285f3ce207dce4273 Mon Sep 17 00:00:00 2001 From: rektdeckard Date: Thu, 14 Nov 2024 11:32:30 -0700 Subject: [PATCH] feat(docs): add TEMPLATE.md --- TEMPLATE.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 TEMPLATE.md diff --git a/TEMPLATE.md b/TEMPLATE.md new file mode 100644 index 0000000..3d07ce5 --- /dev/null +++ b/TEMPLATE.md @@ -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/).