How operacle/checkcle works
Project type and purpose
• CheckCle is a full-stack, open-source monitoring platform.
• It comprises a React+TypeScript single-page application (SPA) in the application/ folder and a PocketBase backend (Go) in the server/ folder.
• Docker Compose glues everything together for local development and production.
File structure
• Top level:
• application/ – the Vite-powered React SPA
• server/ – PocketBase binary, migration scripts, SQLite data
• docker/ + docker-compose.yml – container definitions for dev/prod
• scripts/ – setup/entrypoint shell scripts
• In application/:
• src/pages/ implements route-level views (Dashboard, Login, Settings, etc.)
• src/components/ holds UI components (dashboard, services, profile, settings, ssl-domain)
• src/services/ contains API wrappers (authService, serviceService, etc.), monitoring logic (httpChecker, monitoring intervals), notification logic (telegramService, signalService, templateProcessor)
• src/api/ configures REST + real-time (WebSocket) communication with PocketBase
• src/lib/pocketbase.ts – initializes the PocketBase SDK client
• vite.config.ts, tsconfig.json, tailwind.config.ts – build tool and styling configs
• In server/:
• pb_data/ – SQLite files for data persistence
• pb_migrations/ – JSON and JS migration scripts defining collections (services, uptimes, alert configurations)
• pocketbase/ – the backend executable
README for additional insights
• Real-time monitoring of HTTP, DNS, Ping, TCP services
• Incident history, SSL/domain checks, user and alert management
• Notification channels: Email, Telegram, Discord, Slack
• Multi-language, theming, and a settings panel
• Deployed via Docker Compose, exposing port 8090
Elements
– Clear, descriptive labels for each component
• SPA → API calls → PocketBase
• API → DB reads/writes
• Monitoring Engine → DB writes
• Monitoring Engine → Notification Engine → External Channel
• DB → WebSocket pushes → SPA
• UI (blue),
• Backend/core services (green),
• External dependencies (orange),
– Annotations for protocols (HTTP, WebSocket, Docker network)