ticktick-api-lvt

TICKTICK API WRAPPER

Features • Requirements • Usage • Development • About • Community

🎺 Overview

This is a ticktick api wrapper developed to be used on Node.js based projects.

> ⚠️ warning: As of Jan 2024 Ticktick requires a captcha token in order to authenticate user on login. I'm working in order to implement it on this package, but have not yet succeeded. More details on this issue.

🎯 Features

   ✔️ type safe api methods by using zod validation;
   ✔️ methods for common actions, find more here;
   ✔️ support to china api version [thanks to @quanru];
   ✔️ custom headers required in order to make api calls [thanks to @thesamim].

⚠️ Requirements

In order to use this project in your computer, you need to have the following items:

• npm: To install the package. Npm is installed alongside nodejs;
• nodejs: To actually run the package.

💡 Usage

To use it from the registry, first install the npm package:

# Install the package
npm install ticktick-api-lvt

And you can normally use it in your code as it follows:

import { Tick } from 'ticktick-api-lvt';

async function main() {
  const username = 'your_username';
  const password = 'your_password';

  const tickInstance = new Ticktick({ username, password });

  // LOGIN =====================================================================

  await tickInstance.auth.login();

  // METHODS ===================================================================

  console.log(await tickInstance.user.getUserInformation());
  console.log(await tickInstance.user.getUserDailyReminder());
  console.log(await tickInstance.user.getUserSettings());
  console.log(await tickInstance.tags.getTags());
  console.log(await tickInstance.tasks.getCompletedTasks());

}

main();

To see further usage, check out the provided example.

🔧 Development

Development setup

To setup this project in your computer, download it in this link or run the following commands:

# Clone this repository
$ git clone https://github.com/lucasvtiradentes/ticktick-api-lvt

# Go into the repository
$ cd ticktick-api-lvt

After download it, go to the project folder and run these commands:

# Install dependencies using npm
$ npm install

# Run the typescript code in development mode
$ npm run dev

If you want to contribute to the project, after you make the necessary changes, run these commands to check if everything is working fine:

# Compile the code into javascript
$ npm run build

# Run the compiled code in production mode
$ npm run start

Used technologies

This project uses the following thechnologies:

  <td>Commit linting</td>
  <td align="center">
  <a href="https://github.com/conventional-changelog/commitlint"><img src="https://img.shields.io/badge/commitlint-red?logo=commitlint&amp;logoColor=white"></a>
  <a href="https://github.com/commitizen/cz-cli"><img src="https://img.shields.io/badge/commitizen-pink?logo=conventionalcommits&amp;logoColor=white"></a>
  
  </td>
</tr>
<tr>
  
  <td>Other</td>
  <td align="center">
    <a href="https://editorconfig.org/"><img src="https://img.shields.io/badge/Editor%20Config-E0EFEF?logo=editorconfig&amp;logoColor=000"></a>
    <a href="https://github.com/typicode/husky"><img src="https://img.shields.io/badge/🐶%20husky-green?logo=husky&amp;logoColor=white"></a>
    
  </td>
</tr>

Scope	Subject	Technologies
Project	Main
Setup	Code linting

📚 About

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.