/Easy-Annotator

SWENG Project that allows a user to upload a video, select region of interest, comment on the video, and export this information in a JSON format.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Recommended browser: Firefox (Works on all browsers but some UI elements may load incorrectly)

Build Status

A React based project built for IBM research and Dr. Ronan Cahill from UCD. It allows a surgeon or surgeon's assistant to upload a video from surgery from a near infrared camera, select regions of interests (ROIs) that the user believes to possibly be cancerous, write comments on the ROIs and video, and finally export all this data in a JSON format which can be used by the algorithm developed by IBM.

EasyAnnotator Screenshot

This project was developed for Trinity's Computer Science module, Software Engineering Project (CSU22013, CSU33013).

Built by Chole Connely, Cian Galligan, Daniel Grace, Jack Gilbride, Yannick Gloster, David Green, and Luke Hackett.

Getting Started

  1. Install Node.js

  2. Clone this repository

  3. Open up command prompt or teminal and navigate to the location of the cloned repository

  4. Install the dependencies

    npm install
  5. Running the server locally

    npm run dev

    The server should now be hosted on http://localhost:3000

Some Relevant Docs

Building and Publishing with Docker

Building an image

docker build -t <image>:<tag> .

Running the image

docker run -p 3000:3000 <image>:<tag>

Tagging and Publishing

docker build -t <username>/<repository>:<tag> .
docker tag <username>/<repository>:<tag> <username>/<repository>:latest
docker push <username>/<repository>:<tag>

=======

docker build -t <image>:<tag> .

Running the image

docker run -p 3000:3000 <image>:<tag>

Tagging and Publishing

docker build -t <username>/<repository>:<tag> .
docker tag <username>/<repository>:<tag> <username>/<repository>:latest
docker push <username>/<repository>:<tag>