54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
# Voice Agent
|
||
|
||
A Pipecat example demonstrating the simplest way to create a voice agent using `SmallWebRTCTransport`.
|
||
|
||
## 🚀 Quick Start
|
||
|
||
### 1️⃣ Start the Bot Server
|
||
|
||
#### 🔧 Set Up the Environment
|
||
1. Create and activate a virtual environment:
|
||
```bash
|
||
python3 -m venv venv
|
||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||
```
|
||
|
||
2. Install dependencies:
|
||
```bash
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
3. Configure environment variables:
|
||
- Copy `env.example` to `.env`
|
||
```bash
|
||
cp env.example .env
|
||
```
|
||
- Add your API keys
|
||
|
||
#### ▶️ Run the Server
|
||
```bash
|
||
python server.py
|
||
```
|
||
|
||
### 2️⃣ Connect Using the Client App
|
||
|
||
Open your browser and visit:
|
||
```
|
||
http://localhost:7860
|
||
```
|
||
|
||
## 📌 Requirements
|
||
|
||
- Python **3.10+**
|
||
- Node.js **16+** (for JavaScript components)
|
||
- Google API Key
|
||
- Modern web browser with WebRTC support
|
||
|
||
---
|
||
|
||
### 💡 Notes
|
||
- Ensure all dependencies are installed before running the server.
|
||
- Check the `.env` file for missing configurations.
|
||
- WebRTC requires a secure environment (HTTPS) for full functionality in production.
|
||
|
||
Happy coding! 🎉 |