https://github.com/silencesys/dh--image-annotation-tool
Image annotation tool is a web application that allows users to mark zones of interest in an image. These zones are then converted to XML TEI code snippet that can be used in your document to connect the image and the text.
https://github.com/silencesys/dh--image-annotation-tool
image image-annotation-tool image-viewer tei
Last synced: 23 days ago
JSON representation
Image annotation tool is a web application that allows users to mark zones of interest in an image. These zones are then converted to XML TEI code snippet that can be used in your document to connect the image and the text.
- Host: GitHub
- URL: https://github.com/silencesys/dh--image-annotation-tool
- Owner: silencesys
- License: eupl-1.2
- Created: 2021-08-23T15:18:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-03T07:49:18.000Z (over 2 years ago)
- Last Synced: 2025-07-26T13:39:58.783Z (3 months ago)
- Topics: image, image-annotation-tool, image-viewer, tei
- Language: JavaScript
- Homepage: http://ima.coders.tools
- Size: 12.8 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Image Annotation Tool
Image annotation tool is a web application that allows users to mark zones of interest in an image. These zones are then converted to TEI P5 code snippet that can be used in your document to connect the image and the text. This tool was developed to help students and teachers at the [Faculty of Arts, Charles University](https://ff.cuni.cz/) to mark and annotate images of manuscripts.
## Usage
Visit [the app website](http://ima.coders.tools/), open your image and start annotating.
The app can be installed as PWA (Progressive Web App).
## Development
All contributions are welcomed. The web app is written in [React.js](https://facebook.github.io/react/) and uses [React Draggable](https://www.npmjs.com/package/react-draggable) for dragging tool panes.
### Prerequisites
- [Node.js](https://nodejs.org/en/)
- [Git](https://git-scm.com/)
Make sure you have installed the above libraries, otherwise you will not be able to run the app.
### Installation
First of all, you need to get your local clone of the application.
```bash
git clone git@github.com:silencesys/dh--image-annotation-tool.git ImageAnnotationTool
```
Then you need to install the dependencies.
```bash
cd ImageAnnotationTool
npm install
```
Next you can run the application.
```bash
npm run start
```
The application is running on port 3000.
## Used components and libraries
- [React](https://reactjs.org/)
- [OpenSeadragon](https://openseadragon.github.io/)
- [React Draggable](https://www.npmjs.com/package/react-draggable)
- [Font Awesome](https://fontawesome.com/)