Skip to content

STARTUP_GUIDE.md

Latest commit

 

History

History
121 lines (93 loc) · 3.41 KB

STARTUP_GUIDE.md

File metadata and controls

121 lines (93 loc) · 3.41 KB

🚀 Ultimate Voice Bridge - Startup Guide

📋 Current Project Status

Based on the code review, your UVB project has:

  • ✅ Working FastAPI backend with full and simplified versions
  • ✅ Next.js frontend with voice components
  • ✅ RTX 5090 GPU acceleration support
  • ✅ VibeVoice integration for advanced TTS
  • ✅ Multi-speaker conversation engine
  • ⚠️ 300+ security/quality issues found (see Code Issues panel)

🎯 Recommended Startup Process

Option 1: Simple Start (Recommended for Testing)

# 1. Start with simplified backend
cd F:\Git\Projects\UVB-Q-Tac\Ultimate_Voice_Bridge\backend
python simple_main.py
  • Runs on http://localhost:8000
  • Minimal dependencies
  • Good for initial testing

Option 2: Full System (Production)

# 1. Start full backend with GPU acceleration
cd F:\Git\Projects\UVB-Q-Tac\Ultimate_Voice_Bridge\backend
python main.py
  • Full feature set
  • RTX 5090 GPU acceleration
  • VibeVoice integration

Frontend (Both Options)

# 2. Start frontend (separate terminal)
cd F:\Git\Projects\UVB-Q-Tac\Ultimate_Voice_Bridge\frontend
npm run dev
  • Runs on http://localhost:3000
  • Hot reload enabled

🖥️ Optimal VS Code Window Setup

Primary Windows to Keep Open:

  1. 🗂️ Explorer Panel (Left sidebar)

    • Navigate project structure
    • Quick file access

  2. 💬 Amazon Q Chat (Current window)

    • Our conversation
    • AI assistance

  3. 📟 Integrated Terminal (Bottom panel)

    • Split into 2 terminals:
      • Terminal 1: Backend (python simple_main.py)
      • Terminal 2: Frontend (npm run dev)

  4. 🐛 Code Issues Panel (Bottom panel, next to terminal)

    • View the 300+ issues found
    • Get fixes for security/quality problems

  5. 📊 Output Panel (Bottom panel)

    • Service logs and errors
    • Debug information

Secondary Windows (As Needed):

  1. 🔍 Problems Panel - VS Code linting issues
  2. 📝 Editor Tabs - Code files you're working on
  3. 🌐 Browser - http://localhost:3000 for testing

⚡ Quick Commands

VS Code Shortcuts:

  • Ctrl+Shift+P - Command palette
  • `Ctrl+`` - Toggle terminal
  • F5 - Start debugging (use our configured launch tasks)
  • Ctrl+Shift+E - Explorer panel
  • Ctrl+Shift+M - Problems panel

Terminal Commands:

# Check if services are running
curl http://localhost:8000/health    # Backend health
curl http://localhost:3000           # Frontend

# Stop services
Ctrl+C in respective terminals

🔧 Next Steps After Startup

  1. Test Basic Functionality:

    • Visit http://localhost:3000
    • Try voice recording/playback
    • Test API endpoints at http://localhost:8000/docs

  2. Address Critical Issues:

    • Use Code Issues panel to fix security vulnerabilities
    • Focus on Critical and High severity issues first

  3. GPU Acceleration:

    • Verify RTX 5090 is detected: Check /health endpoint
    • Monitor GPU usage during voice processing

🚨 Priority Issues to Fix

From the code review, focus on:

  1. Critical: Package vulnerabilities in requirements.txt
  2. High: Path traversal vulnerabilities
  3. High: Cross-site scripting issues
  4. High: Unrestricted file upload vulnerabilities

Use the Code Issues panel to get specific fixes for each issue.

Ready to start? Run the simple backend first, then we'll test and optimize together! 🎉