Checkstack Documentation

Documentation Index

Welcome to the Checkstack documentation! This index will help you find the information you need.

Getting Started

New to Checkstack? Start here:

1. Project README - Project overview and setup instructions
2. Docker Deployment - Deploy Checkstack with Docker
3. Contributing Guide - Set up your development environment

Architecture

Understanding the system design:

• Plugin Architecture - Core pluggable architecture and extension model
• Packages vs Plugins - When to use packages vs plugins

Backend Development

Building backend plugins and services:

• Backend Plugins - Create REST APIs, services, and database schemas
• Service Communication - Backend-to-backend communication patterns
• Config Service - Dynamic configuration management
• Queue System - Asynchronous task processing
• Signals - Realtime server-to-client communication
• Versioned Configs - Schema evolution and migrations
• Drizzle Schema - Database schema isolation
• Health Check Data Management - Tiered storage, aggregation, and retention
• Health Check Strategies - Building health check providers with assertions
• Notification Strategies - Building notification delivery channels
• Integration System - External system integration architecture
• Integration Events - Event-driven integration hooks
• Integration Providers - Building integration providers

Frontend Development

Building frontend plugins and UI:

• Frontend Plugins - Create UI components, pages, and routing
• Extension Points - UI slots and extension system
• Theming - Design tokens and theme customization
• Config Schemas - Sending configuration schemas to frontend
• Health Check Custom Charts - Strategy-specific visualizations
• Routing - Frontend route management and navigation

Common Packages

Sharing code between frontend and backend:

• Common Plugins - Shared types, access rules, and contracts

Security

Authentication and secrets management:

• Authentication & SSO - SAML, LDAP, group-to-role mapping
• Secrets Encryption - Secret storage and encryption
• Auth Error Handling - Custom authentication error patterns
• External Applications - Service accounts and API access
• Teams and Resource Access Control - Team-based access to specific resources

Testing

Testing utilities and patterns:

• Backend Test Utilities - Mock factories and test helpers
• Frontend Testing - React component and hook testing

Examples

Common patterns and minimal templates:

• Queue Patterns - Recurring jobs, broadcast, priority, deduplication
• Plugin Templates - Minimal backend, frontend, and common plugins
• Config Patterns - Versioning, migrations, secrets

Tooling

Development tools and workflows:

• CLI & Scaffolding - Monorepo tooling and package creation
• Dependency Linter - Architecture rule enforcement
• Changesets - Versioning and changelog management

Quick Reference

Package Types

Type	Purpose	Documentation
Backend	REST APIs, business logic, database	Backend Plugins
Frontend	UI components, pages, routing	Frontend Plugins
Common	Shared types, access rules, constants	Common Plugins

Dependency Rules (Enforced)

• ✅ Common → Common only
• ✅ Frontend → Frontend or Common
• ✅ Backend → Backend or Common
• ❌ Common → Backend or Frontend
• ❌ Frontend → Backend

See Dependency Linter for enforcement details.

Technology Stack

Backend

• Runtime: Bun
• Framework: Hono
• Database: PostgreSQL + Drizzle ORM
• Validation: Zod
• Testing: Bun test

Frontend

• Framework: React
• Routing: React Router DOM
• UI: ShadCN + Tailwind CSS
• Build: Vite
• Testing: Playwright

Getting Help

• Documentation: You’re reading it!
• GitHub Issues: Report bugs or request features
• GitHub Discussions: Ask questions or share ideas

Contributing

We welcome contributions! See the Contributing Guide for:

• Development setup
• Code style guidelines
• Testing requirements
• PR submission process

License

Checkstack is licensed under the Elastic License 2.0.

---

Need help? Check the Contributing Guide for support options.

This site is open source. Improve this page.