Annotorious aims to be a community project - we welcome your involvement!
When contributing, please attempt to match the code style already in the codebase. If you are new to the project, please check out the project Website for the 2.x version of Annotorious first.
If you're new to open source in general, check out GitHub's open source intro guide.
- Install a recent version of Node and npm
- Clone this repository
- Install project dependencies by running
npm installin the project directory
This repository is a monorepo, which means it contains multiple JavaScript modules. We are using npm workspaces to manage the monorepo.
The main packages are located in these folders:
packages/annotorious. The main Annotorious JavaScript library, and the future successor to the current standard version.packages/annotorious-openseadragon. The Annotorious plugin for the OpenSeadragon viewer for zoomable images, and the future successor to the current version of the Annotorious OpenSeadragon plugin
To start developing, enter the folder, run npm start and point your browser to http://localhost:5173/test/index.html. To compile the distribution bundle, run npm run build.
Furthermore, there these additional modules:
packages/annotorious-core. Core components used by both Annotorious and Annotorious OpenSeadragon.packages/annotorious-formats. Additional annotation data formats.packages/annotorious-react. A native React integration for Annotorious and Annotorious OpenSeadragon.