Prompt is too long

2025-10-22 09:06:18 +02:00
parent 8235d8d1b1
commit e646f410be
128 changed files with 9346 additions and 7090 deletions
@@ -0,0 +1,98 @@
+# Voice Assistant
+
+A voice-controlled terminal assistant that runs as a single local service.
+
+## Quick Start
+
+```bash
+# Install dependencies
+npm install
+
+# Copy environment variables
+cp .env.example .env
+# Edit .env and add your API keys (OpenAI, Deepgram)
+
+# Run development servers
+npm run dev
+
+# Open browser to http://localhost:5173
+```
+
+## Architecture
+
+- **Express Server** (port 3000) - Serves API and built UI in production
+- **Vite Dev Server** (port 5173) - Hot-reload React UI in development
+- **WebSocket** (`/ws`) - Real-time bidirectional communication
+- **Agent** - STT → LLM → TTS pipeline with terminal control
+- **Daemon** - tmux-based terminal management (in-process)
+
+## Development
+
+```bash
+# Run both servers (recommended)
+npm run dev
+
+# Or run separately:
+npm run dev:server  # Express on port 3000
+npm run dev:ui      # Vite on port 5173
+
+# Type checking
+npm run typecheck
+
+# Build for production
+npm run build
+
+# Start production server
+npm start
+```
+
+## Project Status
+
+**✅ Completed** (Phases 1-2):
+- Package setup and configuration
+- Express server with WebSocket
+- React UI with Vite
+- WebSocket client with ping/pong testing
+
+**⏳ In Progress** (Phase 3):
+- Terminal control (tmux integration)
+
+**📋 Planned** (Phases 4-9):
+- LLM integration (OpenAI GPT-4)
+- Agent orchestrator
+- Speech-to-Text (Deepgram)
+- Text-to-Speech (OpenAI)
+- Audio streaming
+- UI polish
+
+See [IMPLEMENTATION_PLAN.md](./IMPLEMENTATION_PLAN.md) for complete details.
+
+## Environment Variables
+
+```bash
+OPENAI_API_KEY=sk-...      # GPT-4 and TTS
+DEEPGRAM_API_KEY=...       # Streaming STT
+PORT=3000                  # Server port
+NODE_ENV=development       # Environment
+```
+
+## Tech Stack
+
+- **Server**: Express, TypeScript, ws (WebSocket)
+- **Client**: React 18, Vite, TypeScript
+- **Terminal**: tmux (via child_process)
+- **AI**: OpenAI (LLM + TTS), Deepgram (STT)
+
+## Testing
+
+Currently manual testing via:
+1. Start servers: `npm run dev`
+2. Open http://localhost:5173
+3. Test WebSocket connection (green status indicator)
+4. Click "Send Ping" button to test communication
+
+More testing guidance as features are implemented.
+
+## License
+
+MIT