Skip to content

Packages ​

Tecack consists of 5 packages.

Packages Overview ​

@tecack/frontend ​

The frontend of tecack generates stroke data for tecack from a canvas. The drawing on the canvas and the event handling functions are implemented in this package.
For more details, please refer to the API Reference.

@tecack/backend ​

The backend of tecack takes stroke data and datasets from tecack and implements an algorithm to infer character candidates.
For more details, please refer to the API Reference.

@tecack/dataset ​

Provides datasets used in the backend. This is a set of default datasets prepared for the tecack package, and users can also create their own datasets.
For information on Creating Datasets.

@tecack/shared ​

A shared package. It includes type definitions representing stroke information and encoders/decoders for reducing payload size.
For more details, please refer to the API Reference.

@tecack/tools ​

A set of tools for developers. It is used by developers to create their own datasets for individual projects.
For more details, please refer to Tools Reference.

Installation ​

Each package can be installed individually.

$ npm add @tecack/frontend
$ npm add @tecack/backend
$ npm add @tecack/dataset
$ npm add @tecack/shared
$ npm add -D @tecack/tools
$ npm add @tecack/frontend
$ npm add @tecack/backend
$ npm add @tecack/dataset
$ npm add @tecack/shared
$ npm add -D @tecack/tools
$ pnpm add @tecack/frontend
$ pnpm add @tecack/backend
$ pnpm add @tecack/dataset
$ pnpm add @tecack/shared
$ pnpm add -D @tecack/tools
$ pnpm add @tecack/frontend
$ pnpm add @tecack/backend
$ pnpm add @tecack/dataset
$ pnpm add @tecack/shared
$ pnpm add -D @tecack/tools
$ yarn add @tecack/frontend
$ yarn add @tecack/backend
$ yarn add @tecack/dataset
$ yarn add @tecack/shared
$ yarn add -D @tecack/tools
$ yarn add @tecack/frontend
$ yarn add @tecack/backend
$ yarn add @tecack/dataset
$ yarn add @tecack/shared
$ yarn add -D @tecack/tools
$ bun add @tecack/frontend
$ bun add @tecack/backend
$ bun add @tecack/dataset
$ bun add @tecack/shared
$ bun add -D @tecack/tools
$ bun add @tecack/frontend
$ bun add @tecack/backend
$ bun add @tecack/dataset
$ bun add @tecack/shared
$ bun add -D @tecack/tools

When installed as tecack, all packages excluding tools will be installed.

$ npm add tecack
$ npm add tecack
$ pnpm add tecack
$ pnpm add tecack
$ yarn add tecack
$ yarn add tecack
$ bun add tecack
$ bun add tecack