:trumpet: Overview

Add an one way synchronization from ticktick tasks and github commits to your google calendar and boost your time-tracking capabilities and productivity analysis.

:question: Motivation

This project was deeply inspired by this tool, and my main reason for creating this was to track my progress over my completed ticktick tasks, moving them to another calendar, which was not possible in the mentioned project at the time.

:dart: Features

   ✔️ sync your ticktick tasks to google calendar;    ✔️ sync your github commits to google calendar;    ✔️ every completed task in ticktick will be moved to its corresponding completed google calendar;    ✔️ updates corresponding google calendar event in case of changes in ticktick task date or name;    ✔️ option to send a daily summary notification of what gcalsync has done throughout the day;    ✔️ option to sync each ticktick list to a different google calendar;    ✔️ option to ignore certain tasks based on tags;    ✔️ you can add a url link to run the sync function manually whenever you want.

:warning: Requirements

The only thing you need to use this solution is a gmail/google account.

:bulb: Usage

How it works

It basically sets a function to run in google apps scripts to run at every 5 minutes, and this function is responsable for:

• sync your ticktick tasks to google calendar;
• sync your github commits to google calendar;
• send you optional emails about session. daily changes, errors and new versions.

Installation

To effectively use this project, do the following steps:

if you want to change the google event color, you can choose from 12 options:

1   -> blue
2   -> green
3   -> purple
4   -> red
5   -> yellow
6   -> orange
7   -> turquoise
8   -> gray
9   -> bold blue
10  -> bold green
11  -> bold red

General tips

• in case of deleted ticktick tasks (that means, you dont intend to do it anymore) that are in gcal, make sure to delete in gcal as well. If not, they will be moved to its corresponding completed calendar;
• it is not necessary to generate a github token in order to sync commits, it is only required if you want to sync your contributions to private repos as well;
• every update in ticktick may take 5 minutes to propagate to its ics calendars;

Updating

To update your esports-notifier instance and use the latest features, you just need to change the version number in the getGcalSync function, as it is shown bellow:

So if your instance is running at version "1.0.0" and the latest is "3.6.1", just replace those numbers in the version variable.

It is a good practice to go to the dist folder everytime you update your instance to check if your files in GAS are the same as the new version; if they're not this may cause erros.

Uninstall

If you want to receive the daily emails, just go to the GAS respective project in the header dropdown menu select the uninstall function and then click on the Run button. By doing that, the GAS trigger responsable for running everyday the function will be deleted.

:wrench: Development

Development setup

# Clone this repository
$ git clone https://github.com/lucasvtiradentes/gcal-sync

# Go into the repository
$ cd gcal-sync

# Install dependencies
$ npm install

If you want to contribute to the project, fork the project, make the necessary changes, and to test your work on google apps scripts with do this:

1. run npm run build in order to generate the dist files. After that, create a new GAS file (ex: dev_gcal.gs) and paste the content of gcalsync_dev on this new GAS file.

2. after that, update the content of the getGcalSync as specified bellow:

function getGcalSync() {
  // ...
  const useDevVersion = true; // set this to true to use your gcal-sync version

  if (useDevVersion) {
    const GcalSync = getGcalSyncDev(); // your work is here
  }
  // ...
}

now you can test your work really easy on production/GAS!

Used technologies

This project uses the following thechnologies:

:books: About

Related

• online-ics: online tool to view the content of ICS calendars;
• gas-ics-sync: A Google Apps Script for syncing ICS/ICAL files faster than the current Google Calendar speed. This was my main inspiration;
• esports-notifier: get an daily email whenever one of your favorite eSports team has a match at day in games such as csgo, valorant and rainbow six siege;
• twitch-notifier: get email notifications when only your favorite twitch streamers go live.

License

This project is distributed under the terms of the MIT License Version 2.0. A complete version of the license is available in the LICENSE file in this repository. Any contribution made to this project will be licensed under the MIT License Version 2.0.

Feedback

If you have any questions or suggestions you are welcome to discuss it on github issues or, if you prefer, you can reach me in my social media provided bellow.