Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cleanup tweaks #6

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"semi": true,
"tabWidth": 2,
"useTabs": false,
"singleQuote": false
}
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Try](https://img.shields.io/badge/try_it-here-blue)](https://demo.dailybots.ai)
[![Deploy](https://img.shields.io/badge/Deploy_to_Vercel-black?style=flat&logo=Vercel&logoColor=white)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdaily-demos%2Fdaily-bots-web-demo&env=DAILY_BOTS_URL,DAILY_API_KEY,NEXT_PUBLIC_BASE_URL&project-name=daily-bots-demo&repository-name=daily-bots-web-demo)
[![Deploy](https://img.shields.io/badge/Deploy_to_Vercel-black?style=flat&logo=Vercel&logoColor=white)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fdaily-demos%2Fdaily-bots-web-demo&env=DAILY_API_KEY,DAILY_BOTS_URL,NEXT_PUBLIC_BASE_URL&project-name=daily-bots-demo&repository-name=daily-bots-web-demo)


<img src="public/icon.png" width="120px">
Expand All @@ -9,11 +9,6 @@

Example NextJS app that demonstrates core capabilities of [Daily Bots](https://bots.daily.co).

## Other demos

- [Vision](https://github.com/daily-demos/daily-bots-web-demo/tree/khk/vision-for-launch) - Anthropic, describe webcam.
- [Function calling](https://github.com/daily-demos/daily-bots-web-demo/tree/cb/function-call) - Anthropic, function calling (get current weather)

## Getting started

### Configure your local environment
Expand All @@ -22,26 +17,33 @@ Example NextJS app that demonstrates core capabilities of [Daily Bots](https://b
cp env.example .env.local
```

`NEXT_PUBLIC_BASE_URL` defaults to `/api`, which is configured as Next server-side route handler. You can pass through service API keys, override service and config options within this route.

`DAILY_BOTS_URL` URL of the Daily Bots `start` endpoint (https://api.daily.co/v1/bots/start)
`DAILY_API_KEY`: Your Daily API key obtained by registering at https://bots.daily.co.

`DAILY_BOTS_URL`: URL of the Daily Bots `start` endpoint. Default: https://api.daily.co/v1/bots/start.

`DAILY_API_KEY` your Daily API key obtained by registering at https://bots.daily.co.
`NEXT_PUBLIC_BASE_URL`: Next server-side route handler. You can pass through service API keys, override service and config options within this route. Default: `/api`

`OPENAI_API_KEY` Optional: provide a OpenAI API key. Daily Bots does not provide an integrated OpenAI service, so to use it, you will need to provide your own key. You can read more about integrated and 'bring your own key' [here](https://docs.dailybots.ai/api-reference/client/supportedServices).
`OPENAI_API_KEY`: Optional: provide a OpenAI API key. Read more about integrated and supported services [here](https://docs.dailybots.ai/api-reference/client/supportedServices).

### Install dependencies

```shell
yarn
yarn install
```
or
```shell
npm install
```

### Run the project

```shell
yarn run dev
```
or
```shell
npm run dev
```

## How does this work?

Expand All @@ -58,7 +60,6 @@ Learn more about the RTVI web client libraries [on the docs](https://docs.rtvi.a

All Voice Client configuration can be found in the [rtvi.config.ts](/rtvi.config.ts) file. You can edit any prompts, services of config settings in this file.


### API routes

This project exposes three server-side routes:
Expand All @@ -78,3 +79,8 @@ Daily Bots `https://api.daily.co/v1/bots/start` has some required properties, wh
- `config`
- `services`
- Optional, if using OpenAI: `api_keys`

## Other demos

- [Vision](https://github.com/daily-demos/daily-bots-web-demo/tree/khk/vision-for-launch) - Anthropic, describe webcam.
- [Function calling](https://github.com/daily-demos/daily-bots-web-demo/tree/cb/function-call) - Anthropic, function calling (get current weather)
2 changes: 1 addition & 1 deletion env.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
NEXT_PUBLIC_BASE_URL=/api
DAILY_API_KEY=
DAILY_BOTS_URL=https://api.daily.co/v1/bots/start
NEXT_PUBLIC_BASE_URL=/api
OPENAI_API_KEY=
Loading