Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 4.3 KB

README.md

File metadata and controls

79 lines (56 loc) · 4.3 KB
Raw
CCSync

Web interface + Sync server for Taskwarrior 3.0 and higher

GitHub last commit GitHub pull requests Closed pull requests Dynamic JSON Badge

Website • Documentation • Blogs • GSoC Report • Setup Video

CCSync

CCSync is a web UI and API solution designed to facilitate the retrieval and synchronization of tasks from a taskchampion-sync-server container. It provides a seamless experience for managing tasks across all Taskwarrior 3.0 (and higher) clients, whether using the Taskwarrior CLI, the web frontend, or the Taskwarrior Flutter app.

Table of Contents

Overview

During the development of CCSync, the primary focus was placed on creating a backend that provides a series of commands capable of interacting with the Taskwarrior client on the user's system. These commands enable users to create, read, update, or delete tasks directly from the web frontend, or the Taskwarrior Flutter app. The CCSync API ensures these tasks are synchronized across all Taskwarrior clients connected to the taskchampion-sync-server.

Features

  • Task Management: Create, read, update, and delete tasks using Taskwarrior CLI, a web UI, or the Taskwarrior Flutter app.
  • Cross-Platform Synchronization: Synchronize tasks across all Taskwarrior 3.0+ clients.
  • API Integration: RESTful API to interact with tasks programmatically.
  • User-Friendly Web UI: Manage tasks through a web-based user interface.
  • Flutter App Integration: Seamless integration with the Taskwarrior Flutter app for mobile task management.
  • Backend Commands: A comprehensive set of backend commands to interact with Taskwarrior clients.

Architecture

CCSync comprises three main components:

  1. Backend: The main server-side component that interfaces with Taskwarrior clients, performs operations, and provides a RESTful API.
  2. Web Frontend: A user-friendly web interface built for task management, and credentials retreival.
  3. Taskwarrior Flutter App: The mobile app that allows users to manage tasks on the go, fully integrated with the CCSync API.

For more details, please check out the documentation.

Contributing

We welcome contributions to CCSync! Please read our Contributing Guidelines to get started. Please raise an issue for any query, bug fix, or a feature request.

Community

We would love to hear from you! You may join the CCExtractor community through Slack:

Slack

License

This project is licensed under the MIT License - see the LICENSE file for details.