Features • Requirements • Usage • Development • About • Community
## :trumpet: Overview
This is a [ticktick](ticktick.com) api wrapper developed to be used on [Node.js](https://nodejs.org/en) based projects.
> :warning: **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](https://github.com/lucasvtiradentes/ticktick-api-lvt/issues/13).
## :dart: Features
✔️ type safe api methods by using [zod](https://github.com/colinhacks/zod) validation;
In order to use this project in your computer, you need to have the following items:
- [npm](https://www.npmjs.com/): To install the package. Npm is installed alongside nodejs;
- [nodejs](https://nodejs.org/en/): To actually run the package.
## :bulb: Usage
To use it from the registry, first install the npm package:
```bash
# Install the package
npm install ticktick-api-lvt
```
And you can normally use it in your code as it follows:
```typescript
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](./examples/dev-example.ts).
## :wrench: Development
### Development setup
To setup this project in your computer, download it in this link or run the following commands:
```bash
# 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:
```bash
# 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:
```bash
# 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:
| Scope | Subject | Technologies |
|---|---|---|
| Project | Main |
|
| Setup | Code linting |
|
| Commit linting |
|
|
| Other |
|
## :books: 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](LICENSE) file in this repository. Any contribution made to this project will be licensed under the MIT License Version 2.0.
