cvat/cvat-core

Module CVAT-CORE

Description

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

Versioning

If you make changes in this package, please do following:

• After not important changes (typos, backward compatible bug fixes, refactoring) do: npm version patch
• After changing API (backward compatible new features) do: npm version minor
• After changing API (changes that break backward compatibility) do: npm version major

Commands

• Dependencies installation

npm ci

• Building the module from sources in the dist directory:

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

• Building the documentation in the docs directory:

npm run-script docs

• Running of tests:

npm run-script test

• Updating of a module version:

npm version patch   # updated after minor fixes
npm version minor   # updated after major changes which don't affect API compatibility with previous versions
npm 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