Checkmate - Test Case Management Tool

Welcome to Checkmate! 🎉

This Test Case Management Tool is designed to address the challenges faced by teams in managing and executing test cases with the highest level of availability and reliability. It aims to streamline the testing process, offering robust features, seamless integrations, migration, and user-friendly and intuitive design.

📌 Features

• ✅ Effortlessly manage test cases and categorize them based on labels, squads, sections, priority, and more.
• ✅ Create test runs, update statuses, track progress, download reports, and analyze historical data.
• ✅ Provides integration APIs to seamlessly connect with your testing pipeline.
• ✅ Role-Based Access Control (RBAC) for secure and controlled usage.
• ✅ Integrated Google Login for a hassle-free authentication experience.

🔗 Quick Links

• Detailed Documentation
• Installation Guide
• Product Guide
• API Documentation
• Connect with us on discord

📦 Installation

🚀 One-Line Install (Easiest)

Install Checkmate with a single command:

curl -fsSL https://raw.githubusercontent.com/dream-horizon-org/checkmate/master/bootstrap.sh | bash

Or using wget:

wget -qO- https://raw.githubusercontent.com/dream-horizon-org/checkmate/master/bootstrap.sh | bash

This will download and run the interactive installer that walks you through everything.

Alternative: Direct Install Script

If you prefer to download the script first:

# Download
curl -fsSL https://raw.githubusercontent.com/dream-horizon-org/checkmate/master/install.sh -o install.sh
chmod +x install.sh

# Run
./install.sh

Or clone the repository first:

git clone git@github.com:dream-horizon-org/checkmate.git
cd checkmate
./install.sh

The script will:

• ✅ Check and install prerequisites (Git, Node.js v20, Yarn, Docker)
• ✅ Clone the repository (if needed)
• ✅ Guide you through Google OAuth setup with step-by-step instructions
• ✅ Optionally open Google Cloud Console in your browser
• ✅ Prompt for OAuth credentials interactively
• ✅ Automatically configure your .env file
• ✅ Generate secure session secrets
• ✅ Install all dependencies
• ✅ Set up Docker containers and seed database

No manual configuration needed! The script walks you through each step.

Manual Installation

Pre-requisites

1. Docker Desktop
2. Node.js (v18.x or higher)
3. Yarn
4. Google OAuth Application

Setup Steps

1. Clone the repository:

   git clone git@github.com:dream-horizon-org/checkmate.git
   cd checkmate

2. Create an .env file at root level, based on .env.example.

   cp .env.example .env

3. Install dependencies

   yarn install

4. Set up the application and database:

   yarn docker:setup

   • Create both the application and database containers using Docker.
   • Seed the database with initial data.
5. App will be started on http://localhost:3000

📖 API Documentation

Postman collection of APIs is currently available, comprehensive documentation is in progress.

🤖 MCP Server

Checkmate includes an MCP (Model Context Protocol) server that allows AI assistants like Claude to interact with your Checkmate instance programmatically.

Features:

• ✅ Full API access through AI assistants
• ✅ Manage tests, projects, and runs via natural language
• ✅ Update test statuses and track progress
• ✅ Query test history and analytics
• ✅ TypeScript-based with full type safety
• ✅ Docker support for production deployment

Local Development Setup:

For local development, start both the app and MCP server together:

# Start Checkmate app and MCP server together
yarn dev:with-mcp

Or run separately:

# Terminal 1: Start Checkmate app
yarn dev

# Terminal 2: Start MCP server
yarn mcp:dev

Prerequisites:

1. Get your API token from Checkmate UI (User Settings → API Tokens → Generate Token)
2. Update mcp-server/.env with your token:

   CHECKMATE_API_BASE=http://localhost:3000
   CHECKMATE_API_TOKEN=your-api-token-here

Docker Deployment:

# Start all services including MCP server
docker-compose up -d

# Check MCP server status
docker-compose ps checkmate-mcp

# View MCP server logs
docker-compose logs -f checkmate-mcp

Documentation:

• MCP Server API Reference - Complete API reference
• MCP Tools Guide - Tool usage examples
• Docker Deployment - Production deployment with Docker

⚙️ TechStack Used:

• Remix
• Drizzle
• MySQL
• Shadcn
• Casbin (RBAC)

Created by Dream Horizon

Dream Horizon is committed to building open-source tools that empower developers and businesses. Learn more about us at our website.

🚀 Contribute to Checkmate

Checkmate is an open-source project and welcomes contributions from the community. For details on how to contribute, please see our guide to contributing.

⚖️ License

This project is published under the MIT License.

✉️ Contact

If you need feedback or support, reach out via the Issue Tracker or Discord.