Table of Contents

• Overview
• Screenshots
• Features
• Architecture
• Development Setup
• Contributing
• License

Overview

CCSync is a web UI and API that synchronizes your Taskwarrior tasks across all your clients using a taskchampion-sync-server.

Whether you prefer the CLI, Web Frontend, or Flutter Mobile App, CCSync keeps everything in sync efficiently and securely.

Screenshots

Features

• Task Management — Create, read, update, and delete tasks seamlessly.
• Cross-Platform Sync — Keep all Taskwarrior 3.0+ clients in sync automatically.
• RESTful API — Manage and query tasks programmatically.
• Web Frontend — Clean and responsive UI for easy task handling.
• Mobile Integration — Compatible with the Taskwarrior Flutter App.
• Backend Commands — Full control via Taskwarrior-compatible commands.

Architecture

CCSync is composed of three core modules:

1. Backend — The REST API and logic layer that communicates with Taskwarrior clients.
2. Web Frontend — A modern web UI that stores and manages tasks in-browser.
3. Taskchampion Sync Server — In order to sync tasks with you Taskwarrior instances, CCSync by default uses the offical Taskchampion sync server image to sync tasks.

📖 Learn more in the official documentation.

Development Setup

Want to contribute or run CCSync locally? We've made it easy!

Quick Start with Tmux (Recommended)

Run all services (backend, frontend, and sync server) in a single command:

This will start all three services in separate tmux panes. See development/README.md for detailed setup instructions, prerequisites, and troubleshooting.

Manual Setup

Alternatively, you can run each service separately:

• Backend: See backend/README.md
• Frontend: See frontend/README.md
• Full Stack: Use docker-compose up
• Sync Server: Use docker-compose up syncserver

Testing with Postman

1. Open Postman.
2. Click Import → Select ccsync.postman_collection.json.
3. Modify the body fields and start testing!

Contributing

We welcome all type of contributions!
Check out the Contributing Guidelines and raise issues or PRs.

Community

Join discussions and get support on Zulip 👇

License

Licensed under the MIT License — see the LICENSE file for details.

🔝 Back to Top