Introduction
What is Checkmate?
Checkmate is a self-hosted test case management system built for teams that need a reliable, scalable solution to organize, execute, and track software testing.
Built with modern web technologies (Remix, TypeScript, MySQL), Checkmate provides an intuitive interface for managing test cases while offering powerful APIs for automation and CI/CD integration.
Key Features
📦 Project Management
Organize tests into projects with role-based access control
✅ Test Case Management
Create, edit, and organize tests with flexible attributes and hierarchical sections
🔄 Test Runs
Execute test runs, track progress in real-time, and generate comprehensive reports
🏷️ Flexible Organization
Use sections, labels, and squads to classify and filter tests your way
🔌 API Integration
RESTful APIs with OpenAPI 3.0 spec for automation and third-party tools
🔐 Security & Access Control
Google OAuth authentication with role-based permissions (Admin, User, Reader)
Core Capabilities
Projects
Organize your testing efforts by application, feature, or service. Each project maintains its own test cases, runs, and metadata.
Test Cases
Comprehensive test documentation with:
- Classification - Priority, platform, automation status, test type
- Organization - Hierarchical sections, team squads, flexible labels
- Details - Preconditions, steps, expected results, Jira links, defects
- Bulk Operations - Import/export tests via CSV
Test Runs
Execution tracking and reporting:
- Create runs from filtered test sets
- Update test statuses (Passed, Failed, Blocked, Retest, Skipped)
- Real-time progress monitoring
- Lock completed runs to preserve results
- Download CSV reports
APIs
Programmatic access for automation:
- RESTful API design
- Session cookie or token authentication
- Complete OpenAPI 3.0 specification
- Client library generation support
Who Should Use Checkmate?
QA Teams
Centralize test case documentation and execution tracking for manual and automated testing workflows.
Development Teams
Integrate test management with CI/CD pipelines using APIs for automated test execution and reporting.
Product Teams
Track testing coverage, progress, and quality metrics across projects and releases.
Why Checkmate?
Self-Hosted & Open Source
Deploy on your infrastructure with full control over your data.
Modern Tech Stack
Built with Remix, TypeScript, MySQL, and Docker for reliability and performance.
Developer-Friendly
RESTful APIs, OpenAPI spec, and comprehensive documentation for easy integration.
Flexible Organization
Hierarchical sections, dynamic labels, and team squads adapt to your workflow.
Simple Deployment
Docker Compose setup gets you running in minutes.
Quick Start
Ready to get started? Follow the setup guide to install Checkmate locally.
🚀 Setup Guide
Install and configure Checkmate
📖 User Guide
Learn how to use Checkmate
🔌 API Documentation
Integrate with your tools
🏗️ Architecture
Understand the system design
Technology Stack
| Layer | Technologies |
|---|---|
| Frontend | Remix, React, TypeScript, shadcn/ui, TailwindCSS |
| Backend | Node.js, Remix, Drizzle ORM |
| Database | MySQL 8.0 |
| Authentication | Google OAuth 2.0, Casbin RBAC |
| Infrastructure | Docker, Docker Compose |
Community & Support
- GitHub: dream-sports-labs/checkmate
- Discord: Join our community
- Issues: Report bugs or request features
License
Checkmate is open source and available under the MIT License.