Cron Observer

An open-source task scheduling and execution tracking system where external systems execute tasks and report status/logs via SDK.

Quick Start

1. Read the Master Plan for project overview
2. Follow modules in order:
   • ✅ Module 1: Project Structure - Complete
   • ✅ Module 2: Data Models - Complete
   • ✅ Module 3: Database Setup - Complete
   • ✅ Module 4: API Endpoints - Complete (includes TaskGroups)
   • ✅ Module 5: Scheduler Engine - Complete
   • 🚧 Module 6: SDK/API - Coming soon
   • 🚧 Module 7: Execution Tracking - Coming soon
   • 🚧 Module 8: Frontend - Coming soon
   • 🚧 Module 9: Testing - Coming soon
   • 🚧 Module 10: Deployment - Coming soon

Project Status

🚀 Active Development - Phase 2 (Core Backend) - Core API, scheduler, and TaskGroup functionality implemented

See backend/README.md for development setup and API documentation.

Key Features

• Task Scheduling: Complex cron-like scheduling with timezone support
• Task Groups: Group tasks together with time windows and coordinated control
• External Execution: Tasks executed by external systems, not by Cron Observer
• Status Tracking: Real-time execution status updates via SDK (planned)
• Log Management: Append-only logs with timestamps and levels (planned)
• Execution History: Complete history with date-based navigation (planned)
• UUID-Based: Tasks and executions use UUIDs for external reference
• OpenAPI Specification: Auto-generated API documentation (swagger.json/yaml)

Architecture

Cron Observer (Scheduler & Tracker)
    ↓ Creates execution records (PENDING)
    ↓
External Systems (Execute actual work)
    ↓ Report status & logs via SDK
    ↓
Cron Observer (Tracks & Displays)

Documentation Structure

• MASTER_PLAN.md: Complete project overview, goals, requirements
• docs/MODULE_XX_*.md: Phase-by-phase implementation guides
• Each module is self-contained and can be implemented independently

Development Approach

This project follows a modular, phase-by-phase development approach:

1. Plan First: Each module has complete documentation before implementation
2. Incremental: Build and test each module before moving to the next
3. Documentation-Driven: Code follows documented specifications

License

[To be determined - Open source license]

Contributing

[Contributing guidelines to be added]

---

Note: Core backend functionality is implemented and actively being developed. Frontend, execution tracking, and SDK endpoints are planned for upcoming phases.