cvat/cvat-core/README.md

Module CVAT-CORE

Description

This CVAT module is a client-side JavaScript library for management of objects, frames, logs, etc. It contains the core logic of the Computer Vision Annotation Tool.

Commands

• Dependencies installation

yarn install --immutable

• Building the module from sources in the dist directory:

yarn run build
yarn run build --mode=development     # without a minification

• Running of tests:

yarn run test

• Updating of a module version:

yarn version --patch   # updated after minor fixes
yarn version --minor   # updated after major changes which don't affect API compatibility with previous versions
yarn version --major   # updated after major changes which affect API compatibility with previous versions

Visual studio code configurations:

• cvat.js debug starts debugging with entrypoint api.js
• cvat.js test builds library and runs entrypoint tests.js