You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Roman Donchenko d15a3199c2 Fix many spelling errors (#3244 ) * Fix spelling errors * Bump version numbers after the spelling fixes * Fix OSX build (os.mknod requires super-priviligies) * Fixed eslint warnings. Co-authored-by: Nikita Manovich <nikita.manovich@intel.com>		5 years ago
..
docs	Interpolation of polyshapes in CVAT (#1571 )	6 years ago
src	Fix many spelling errors (#3244 )	5 years ago
tests	Fix many spelling errors (#3244 )	5 years ago
.dockerignore	User interface with React and antd (#785 )	6 years ago
.eslintignore	Projects (#2255 )	5 years ago
.eslintrc.js	[Dependent] Simple Review Pipeline (Client) (#2357 )	5 years ago
.gitignore	Added package-lock.json to cvat-core. (#1995 )	6 years ago
README.md	Fix many spelling errors (#3244 )	5 years ago
jest.config.js	Move coverage via "jest" to coverage via integration tests. (#2675 )	5 years ago
jsdoc.config.js	Fixes for eslint & precommit configuration (#2352 )	5 years ago
package-lock.json	Fix many spelling errors (#3244 )	5 years ago
package.json	Fix many spelling errors (#3244 )	5 years ago
webpack.config.js	Reformatted (#2349 )	5 years ago

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.

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