LeagueSphere

Documentation

The project uses a structured documentation approach in the docs/ directory for clarity and accessibility.

Primary Resource:

• Contributor Guide: Build, Test, Code Style, and Safety Guidelines.

Specialized Guides:

• Setup Guide: docs/guides/setup-guide.md (Local environment configuration).
• Gemini CLI Guide: GEMINI.md.
• Claude Code Guide: CLAUDE.md.
• General Agent Guide: AGENTS.md.

Directory Structure:

• docs/arch/: Architectural Decision Records (ADR) and system design.
• docs/features/: Feature-specific documentation (Current and History).
• docs/guides/: Setup, onboarding, and contributor guides.
• docs/plans/: Historical and current implementation plans.
• docs/reports/: Verification reports, summaries, and performance analysis.
• docs/testing/: Test scenarios and testing strategies.

Installation

This project uses uv for package management.

uv sync --extra test  # Install with test dependencies

Development & Deployment

For comprehensive development guidelines, see Contributor Guide — the authoritative source for all developers.

Quick reference:

# Install & run
uv sync --extra test
python manage.py runserver

# Test & verify
pytest                                    # Backend tests
npm run test:run                         # Frontend tests (from app dir)
black .                                   # Format backend
npm run eslint                           # Lint frontend

# Migrations
python manage.py makemigrations
python manage.py migrate

# Static files
python manage.py collectstatic

See the docs/guides/ directory for:

• Contributor Guide — Build, test, release workflow
• Coding Standards — Code rules and linting standards
• Infrastructure Policy — Deployment safety protocols
• Setup Guide — Local environment configuration