Development Setup

EPGOAT Documentation - User Guides

Development Environment Setup

Status: Active (Stub - to be expanded) Last Updated: 2025-11-02 Related Docs: Quick Start, Command Reference Code Location: backend/epgoat/

Priority: URGENT Estimated Time: 30-45 minutes

🚧 This Document Is Under Construction

This is a placeholder for the full development setup guide.

Why it's missing: Referenced in 00-START-HERE.md but content not yet written during documentation consolidation.

When it will be complete: Phase 2 (this week)

Tracking: See Documentation Audit

Temporary Quick Start

Until this guide is complete, use these resources:

1. Quick Start Guide (EXISTS)

See Quick-Start.md for initial setup and first EPG generation.

2. CLAUDE.md (EXISTS)

See project root CLAUDE.md for: - Development setup commands - Key commands - Environment variables - Testing commands

3. Repository README (EXISTS)

See project root README.md for project overview.

Planned Content (TO BE WRITTEN)

When complete, this guide will cover:

Prerequisites

  • macOS/Linux/Windows WSL setup
  • Python 3.11+ installation
  • Git configuration
  • IDE setup (VS Code recommended)

Repository Setup

  1. Clone repository
  2. Create virtual environment
  3. Install dependencies
  4. Configure environment variables
  5. Initialize database

Development Tools

  • Linting (ruff, black)
  • Type checking (mypy)
  • Testing (pytest)
  • Pre-commit hooks
  • Git workflow

Verification

  • Run tests
  • Generate sample EPG
  • Access admin UI
  • Verify database connection

Troubleshooting

  • Common setup issues
  • Environment problems
  • Dependency conflicts
  • Database connection issues

IDE Configuration

  • VS Code settings
  • Recommended extensions
  • Debugger setup
  • Test runner configuration

Quick Commands (Temporary)

Until full guide exists, essential commands:

# Clone and setup
git clone <repo-url>
cd epgoat-internal
python -m venv venv
source venv/bin/activate  # macOS/Linux
pip install -r requirements.txt

# Environment
cp .env.example .env
# Edit .env with your credentials

# Verify setup
make test
cd backend/epgoat
python epg_generator.py --help

Want to help write this? See Documentation Standards for how to contribute.