Skip to content

QUICKSTART.md

Latest commit

 

History

History
93 lines (68 loc) · 1.88 KB

QUICKSTART.md

File metadata and controls

93 lines (68 loc) · 1.88 KB

Quick Start Guide

Get the SideQuest Overlay running in 2 minutes!

Prerequisites

Install Poetry (one-time setup):

curl -sSL https://install.python-poetry.org | python3 -

Setup

# Clone/navigate to the project
cd /path/to/squaas

# Backend setup
cd backend
poetry install
cp .env.example .env
# Edit .env and add your OPENAI_API_KEY

# Frontend setup  
cd ../frontend
npm install

# Done!

Run

Terminal 1 - Backend:

cd backend
poetry run uvicorn main:app --reload --port 8787

# OR use the script:
./run_server.sh

Terminal 2 - Frontend:

cd frontend
npm run dev

Terminal 3 - Test it (optional):

cd backend

# Simple test (no OpenAI needed)
poetry run python simple_test.py

# Full demo with AI
poetry run python demo_livestream.py

View

Common Commands

# Backend
cd backend
poetry run uvicorn main:app --reload --port 8787  # Start server
poetry run python simple_test.py                   # Quick test
poetry run python demo_livestream.py               # Full demo
poetry shell                                       # Enter poetry env

# Frontend
cd frontend
npm run dev                                        # Start dev server
npm run build                                      # Production build

# Check status
curl http://localhost:8787/                        # Backend health
curl http://localhost:8787/api/state               # Current state

No Virtual Environment Management!

Poetry handles everything. Just use:

  • poetry run <command> - Run any command in Poetry's environment
  • poetry shell - Enter the environment (then run commands normally)
  • poetry install - Install/update dependencies
  • poetry add <package> - Add new package

That's it! No venv, no activate, no hassle.