-
Notifications
You must be signed in to change notification settings - Fork 1
Update readme and env examples #57
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
Merged
+81
−77
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| FISHJAM_ID= | ||
| FISHJAM_MANAGEMENT_TOKEN= | ||
| ELEVENLABS_API_KEY= | ||
| GEMINI_API_KEY= |
This file contains hidden or 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 |
|---|---|---|
| @@ -1 +1,79 @@ | ||
| # Deep Sea Stories Example App | ||
| # Deep Sea Stories | ||
|
|
||
| Deep Sea Stories is a real-time, audio-driven game where players solve mysteries with the help of an AI riddle master. | ||
|
|
||
| https://github.com/user-attachments/assets/a88f872e-f707-4014-8855-0a55375ce998 | ||
|
|
||
| Check out our [blog post](https://fishjam.swmansion.com/blog/voice-ai-how-we-built-a-multi-speaker-ai-agent-using-gemini) to learn more! | ||
|
|
||
| ## Running Locally | ||
|
|
||
| Before running locally, make sure to copy `.env.example` to `.env` and set the following values: | ||
|
|
||
| ```bash | ||
| FISHJAM_ID=... | ||
| FISHJAM_MANAGEMENT_TOKEN=... | ||
| GEMINI_API_KEY=... | ||
| ``` | ||
|
|
||
| - You can get `FISHJAM_ID` and `FISHJAM_MANAGEMENT_TOKEN` for free by logging in at <https://fishjam.io/app>. | ||
| - You can generate `GEMINI_API_KEY` for free at <https://aistudio.google.com/api-keys>. | ||
|
|
||
| ### Docker Compose (Recommended) | ||
|
|
||
| The easiest way to run the app is with [Docker Compose](https://docs.docker.com/compose/install/). | ||
|
|
||
| ```bash | ||
| docker compose up --build | ||
| ``` | ||
|
|
||
| You can then access the UI at <http://localhost:5000> | ||
|
|
||
| ### Running Manually | ||
|
|
||
| If you can't use [docker compose](#docker-compose-recommended) to run the project, then you can follow the following steps to run the demo. | ||
|
|
||
| ### Requirements | ||
| - [Node.js](https://nodejs.org/en/download) `>= 24` | ||
| - Yarn `4.9.2` (via [Corepack](https://github.com/nodejs/corepack)) | ||
|
|
||
| 1. Install dependencies from the repo root: | ||
| ```bash | ||
| corepack enable | ||
| yarn install | ||
| ``` | ||
| 2. Configure environment variables: | ||
| - Backend (`packages/backend/.env`): | ||
| ```bash | ||
| FISHJAM_ID="your-fishjam-id" | ||
| FISHJAM_MANAGEMENT_TOKEN="your-management-token" | ||
| GEMINI_API_KEY="your-gemini-api-key" | ||
| ``` | ||
| - Web (`packages/web/.env` or `packages/web/.env.local`): | ||
| ```bash | ||
| VITE_FISHJAM_ID="your-fishjam-id" | ||
| VITE_BACKEND_URL="http://localhost:8000/api/v1" | ||
| ``` | ||
| 3. Start the backend (from repo root): | ||
| ```bash | ||
| yarn workspace @deep-sea-stories/backend start | ||
| ``` | ||
| 4. Start the web client in another terminal (from repo root): | ||
| ```bash | ||
| yarn workspace @deep-sea-stories/web start | ||
| ``` | ||
| 5. Open the UI at <http://localhost:5173>. | ||
|
|
||
| ## Repo Structure | ||
|
|
||
| - `packages/backend`: Fishjam Agent which talks with Google Gemini Live API. | ||
| - `packages/web`: Web client, which connects to the backend and Fishjam in the browser. | ||
| - `packages/common`: Shared TypeScript types and utilities. | ||
| - `docker-compose.yml` + `nginx.conf`: Container setup with a reverse proxy. | ||
|
|
||
| ### Tech Stack | ||
|
|
||
| - Yarn workspaces monorepo with Fastify + tRPC (backend), React + Vite (frontend). | ||
| - [Fishjam](https://fishjam.swmansion.com) for real-time videoconferencing capabilities. | ||
| - [Gemini Live API](https://ai.google.dev/gemini-api/docs/live) for AI riddle master backend. | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| FISHJAM_ID="your-fishjam-id" | ||
| FISHJAM_MANAGEMENT_TOKEN="your-management-token" | ||
| ELEVENLABS_API_KEY="your-elevenlabs-api-key" | ||
| GEMINI_API_KEY="your-gemini-api-key" |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.