-
Notifications
You must be signed in to change notification settings - Fork 2
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
0 parents
commit a329d54
Showing
12 changed files
with
3,933 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,5 @@ | ||
LIVEKIT_URL=<your LiveKit server URL> | ||
LIVEKIT_API_KEY=<your API Key> | ||
LIVEKIT_API_SECRET=<your API Secret> | ||
LIVEKIT_SANDBOX_ID=<your Sandbox ID> | ||
OPENAI_API_KEY=<your OpenAI API Key> |
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,23 @@ | ||
{ | ||
"plugins": ["@typescript-eslint/eslint-plugin"], | ||
"extends": [ | ||
"prettier", | ||
"plugin:prettier/recommended", | ||
"plugin:@typescript-eslint/recommended", | ||
], | ||
"parserOptions": { | ||
"ecmaVersion": 2022, | ||
"ecmaFeatures": {}, | ||
}, | ||
"settings": {}, | ||
"ignorePatterns": ["dist/*"], | ||
"rules": { | ||
"space-before-function-parens": 0, | ||
"@typescript-eslint/no-unused-vars": "error", | ||
"import/export": 0, | ||
"@typescript-eslint/ban-ts-comment": "warn", | ||
"@typescript-eslint/no-empty-interface": "warn", | ||
"@typescript-eslint/consistent-type-imports": "warn", | ||
"@typescript-eslint/no-explicit-any": "warn", | ||
}, | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,187 @@ | ||
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore | ||
|
||
# Logs | ||
|
||
logs | ||
_.log | ||
npm-debug.log_ | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Caches | ||
|
||
.cache | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
|
||
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json | ||
|
||
# Runtime data | ||
|
||
pids | ||
_.pid | ||
_.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
|
||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
|
||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
|
||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
|
||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
|
||
bower_components | ||
|
||
# node-waf configuration | ||
|
||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
|
||
build/Release | ||
|
||
# Dependency directories | ||
|
||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
|
||
web_modules/ | ||
|
||
# TypeScript cache | ||
|
||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
|
||
.npm | ||
|
||
# Optional eslint cache | ||
|
||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
|
||
.stylelintcache | ||
|
||
# Microbundle cache | ||
|
||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
|
||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
|
||
*.tgz | ||
|
||
# Yarn Integrity file | ||
|
||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
|
||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
|
||
.parcel-cache | ||
|
||
# Next.js build output | ||
|
||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
|
||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
|
||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
|
||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
|
||
# public | ||
|
||
# vuepress build output | ||
|
||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
|
||
.temp | ||
|
||
# Docusaurus cache and generated files | ||
|
||
.docusaurus | ||
|
||
# Serverless directories | ||
|
||
.serverless/ | ||
|
||
# FuseBox cache | ||
|
||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
|
||
.dynamodb/ | ||
|
||
# TernJS port file | ||
|
||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
|
||
.vscode-test | ||
|
||
# yarn v2 | ||
|
||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
# IntelliJ based IDEs | ||
.idea | ||
|
||
# Finder (MacOS) folder config | ||
.DS_Store | ||
|
||
# turbo | ||
.turbo | ||
|
||
# API extractor | ||
temp | ||
|
||
# typedoc | ||
docs | ||
|
||
# direnv | ||
.direnv |
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,12 @@ | ||
{ | ||
"singleQuote": true, | ||
"trailingComma": "all", | ||
"semi": true, | ||
"tabWidth": 2, | ||
"printWidth": 100, | ||
"importOrder": ["<THIRD_PARTY_MODULES>", "^[./]"], | ||
"importOrderSeparation": false, | ||
"importOrderSortSpecifiers": true, | ||
"importOrderParserPlugins": ["typescript"], | ||
"plugins": ["@trivago/prettier-plugin-sort-imports"] | ||
} |
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,49 @@ | ||
<a href="https://livekit.io/"> | ||
<img src="./.github/assets/livekit-mark.png" alt="LiveKit logo" width="100" height="100"> | ||
</a> | ||
|
||
# Node.js Voice Pipeline Agent | ||
|
||
<p> | ||
<a href="https://cloud.livekit.io/projects/p_/sandbox"><strong>Deploy a sandbox app</strong></a> | ||
• | ||
<a href="https://docs.livekit.io/agents/overview/">LiveKit Agents Docs</a> | ||
• | ||
<a href="https://livekit.io/cloud">LiveKit Cloud</a> | ||
• | ||
<a href="https://blog.livekit.io/">Blog</a> | ||
</p> | ||
|
||
A basic example of a voice pipeline agent using LiveKit and the Node.js [Agents Framework](https://github.com/livekit/agents-js). | ||
|
||
## Dev Setup | ||
|
||
Clone the repository and install dependencies: | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
Set up the environment by copying `.env.example` to `.env.local` and filling in the required values: | ||
|
||
- `LIVEKIT_URL` | ||
- `LIVEKIT_API_KEY` | ||
- `LIVEKIT_API_SECRET` | ||
- `OPENAI_API_KEY` | ||
- `ELEVENLABS_API_KEY` | ||
- `DEEPGRAM_API_KEY` | ||
|
||
You can also do this automatically using the LiveKit CLI: | ||
|
||
```bash | ||
lk app env | ||
``` | ||
|
||
To run the agent, first build the TypeScript project, then execute the output with the `dev` or `start` commands: | ||
|
||
```bash | ||
pnpm build | ||
node dist/agent.js dev # see agents-js for more info on subcommands | ||
``` | ||
|
||
This agent requires a frontend application to communicate with. You can use one of our example frontends in [livekit-examples](https://github.com/livekit-examples/), create your own following one of our [client quickstarts](https://docs.livekit.io/realtime/quickstarts/), or test instantly against one of our hosted [Sandbox](https://cloud.livekit.io/projects/p_/sandbox) frontends. |
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,32 @@ | ||
{ | ||
"name": "voice-pipeline-agent-node", | ||
"version": "0.1.0", | ||
"private": true, | ||
"type": "module", | ||
"scripts": { | ||
"build": "tsc", | ||
"lint": "eslint -f unix \"**/*.ts\"" | ||
}, | ||
"packageManager": "[email protected]", | ||
"devDependencies": { | ||
"@eslint/eslintrc": "^3.1.0", | ||
"@eslint/js": "^9.13.0", | ||
"@trivago/prettier-plugin-sort-imports": "^4.3.0", | ||
"@types/node": "^22.8.6", | ||
"@typescript-eslint/eslint-plugin": "^8.12.2", | ||
"eslint": "^8.57.1", | ||
"eslint-config-prettier": "^9.1.0", | ||
"eslint-plugin-import": "^2.31.0", | ||
"eslint-plugin-prettier": "^5.2.1", | ||
"typescript": "^5.6.3" | ||
}, | ||
"dependencies": { | ||
"@livekit/agents": "^0.4.3", | ||
"@livekit/agents-plugin-deepgram": "^0.4.3", | ||
"@livekit/agents-plugin-elevenlabs": "^0.4.3", | ||
"@livekit/agents-plugin-openai": "^0.4.3", | ||
"@livekit/agents-plugin-silero": "^0.4.3", | ||
"dotenv": "^16.4.5", | ||
"zod": "^3.23.8" | ||
} | ||
} |
Oops, something went wrong.