Welcome to FireBreak Platform Documentation¶

Wildfire risk assessment, done right. Fast, global, and ready for anything.

What is FireBreak?¶

FireBreak is a next-generation wildfire risk assessment platform that combines:

• Geospatial Analysis: Process terrain, vegetation, and weather data to calculate risk scores
• Real-Time Weather: Integrate with weather APIs for current conditions and forecasts
• Report Generation: Automated PDF reports with maps, charts, and recommendations
• Multi-Tenant Architecture: Serve multiple clients with complete data isolation
• Edge Deployment: Global CDN distribution via Cloudflare Workers

Key Features¶

• ✅ Python Backend - Geospatial processing with numpy, rasterio, and shapely
• ✅ JavaScript Frontend - Modern React/TypeScript UI with Mapbox GL
• ✅ Cloudflare Stack - Workers, Pages, R2, D1, KV, Images, Stream
• ✅ Multi-Tenant - Complete isolation with dedicated subdomains
• ✅ Automated Testing - Unified QA harness with unit, integration, and E2E tests
• ✅ CI/CD Pipeline - Automated deployment with rollback capability
• ✅ OpenAPI Spec - Interactive API documentation with Swagger/Redoc
• ✅ Monitoring - Real-time metrics, logging, and alerting

Quick Links¶

Platform Architecture¶

graph TB
    subgraph "Edge Layer - Cloudflare Global Network"
        A[Cloudflare Pages<br/>Frontend CDN]
        B[Cloudflare Workers<br/>Python Backend]
        C[Cloudflare Images<br/>Image Processing]
    end

    subgraph "Storage Layer"
        D[R2 Object Storage<br/>Maps, Reports, Data]
        E[D1 Database<br/>Structured Data]
        F[KV Storage<br/>Cache & Config]
    end

    subgraph "External Services"
        G[Weather APIs]
        H[Terrain Data]
    end

    User([User Browser]) -->|HTTPS| A
    User -->|API Requests| B
    B --> D
    B --> E
    B --> F
    B --> C
    B --> G
    B --> H

    style A fill:#f96,stroke:#333,stroke-width:2px
    style B fill:#fc9,stroke:#333,stroke-width:2px
    style C fill:#9cf,stroke:#333,stroke-width:2px
    style D fill:#9f9,stroke:#333,stroke-width:2px
    style E fill:#9f9,stroke:#333,stroke-width:2px
    style F fill:#9f9,stroke:#333,stroke-width:2px

Technology Stack¶

Development Teams¶

FireBreak is developed by specialized teams working in parallel:

• Team Alpha - Backend & API development (backend/CLAUDE.md)
• Team Beta - Frontend & UI (frontend/CLAUDE.md)
• Team Gamma - Multi-Tenant infrastructure (tenants/CLAUDE.md)
• Team Delta - QA & Testing (qa/CLAUDE.md)
• Team Epsilon - DevOps & CI/CD (.github/CLAUDE.md)

See Team Coordination for workflow details.

Current Status¶

Support & Community¶

• 📖 Documentation: You're reading it!
• 💬 Issues: GitHub Issues
• 🔧 Source Code: GitHub Repository
• 📧 Support: See Support Channels

License¶

FireBreak is proprietary software. See License for details.