README.md

Surf Alerts

Serverless platform that scrapes surf forecast data from Surfline and stores it in AWS S3. Uses AWS CDK for infrastructure and GitHub Actions for CI/CD.

Quick Start

# Install dependencies
uv sync

# Run tests
pytest

# Lint
ruff check .

Infrastructure

cd infrastructure
npm ci
npx cdk synth
npx cdk deploy SufAlertsStack --require-approval never

Project Structure

packages/
├── scrapers/
│   ├── forecast_scraper/    # 6-endpoint forecast data scraper
│   ├── spot_scraper/        # Spot metadata scraper
│   ├── sitemap_scraper/     # Surfline sitemap parser
│   └── taxonomy_scraper/    # Geographic hierarchy walker
├── jobs/
│   ├── dispatcher/          # Job orchestration (planned)
│   └── spot_reconciler/     # Spot change detection
├── migrations/
│   └── archive_legacy_data/ # JSON → Parquet migration
├── cli/                     # CLI (planned)
├── frontend/                # Next.js frontend (planned)
infrastructure/              # AWS CDK (TypeScript)
docs/                        # Documentation (GitBook)

Documentation

Full docs at docs/ — architecture, API reference, data model, and more.