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.

• ✅ 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.

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

Install Checkmate with a single command:

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

Or using wget:

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

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

If you prefer to download the script first:

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

# Run
./install.sh

Or clone the repository first:

git clone [email protected]:ds-horizon/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.

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

1. Clone the repository:

   git clone [email protected]:ds-horizon/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

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

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

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

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

This project is published under the MIT License.

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