Skip to content

drengskapur/checkmate

Repository files navigation

CheckMate: Streamline Your Checklists and Workflows

CheckMate Logo

CheckMate is a Chrome extension that transforms markdown checklists into interactive, reusable task lists. It's designed for anyone who needs to manage complex processes, ensure consistency, or simply stay organized in their work or personal life.

Why CheckMate?

  • Standardize Processes: Create and share consistent checklists across your team or for personal use.
  • Reduce Errors: Follow step-by-step guides to ensure no critical steps are missed in any process.
  • Improve Efficiency: Reuse checklists for recurring tasks, saving time and reducing mental load.
  • Flexible Usage: Suitable for various scenarios, from project management to travel planning, and from technical setups to daily routines.

Key Features

  • 📤 Import markdown checklists directly from your existing documents
  • 📋 Manage multiple checklists for different projects or areas of your life
  • 👁️ Toggle between list and carousel views for different workflow preferences
  • ✏️ Edit checklist items to adapt to specific scenarios
  • 🌓 Dark mode for comfortable viewing in any environment
  • 📱 Responsive design for use on various devices
  • 🔄 Export completed checklists for documentation or sharing

Who Can Benefit from CheckMate?

  • Project Managers coordinating complex workflows
  • Teachers planning lessons or managing classroom activities
  • Event Planners ensuring all details are covered
  • Travelers creating packing lists or itineraries
  • Home Cooks following recipes or meal prep plans
  • Students organizing study plans or research projects
  • IT Professionals managing system configurations
  • Anyone who wants to bring more structure to their tasks and processes

Technical Details

  • Built with standard web technologies for compatibility and performance
  • Styled using Tailwind CSS for a clean, professional look
  • Utilizes browser storage for data persistence without external dependencies

Getting Started

Installation

  1. Clone the repository:

    git clone https://github.com/drengskapur/checkmate.git
  2. Navigate to the project directory:

    cd checkmate
  3. Install dependencies:

    npm install
  4. Build the extension:

    npm run build
  5. Load in Chrome:

    • Open chrome://extensions/
    • Enable "Developer mode"
    • Click "Load unpacked" and select the dist directory

Development

Start the development server:

npm run dev

Production Build

Create a production-ready build:

npm run build

Usage Guide

  1. Click the CheckMate icon in your Chrome toolbar.
  2. Upload your markdown checklists in the "Upload" section.
  3. Manage and customize your checklists in the "Manage" view.
  4. Use the "View" section to work through your checklists interactively.

Best Practices

  • Structure your checklists with clear, actionable items.
  • Include categories or tags to organize related tasks.
  • Use markdown links to reference relevant resources or additional information.
  • Regularly update your checklists to reflect new information or changing processes.

Contributing

We welcome contributions from users with diverse backgrounds and experiences. Please review our Contributing Guidelines before submitting pull requests.

Support

If you encounter issues or have questions, please file an issue on our GitHub Issues page.

License

CheckMate is open-source software licensed under the MIT license.


CheckMate Icon

CheckMate: Your guide to ensuring consistent and accurate workflows in any domain.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published