Description

Fruitful Annotator is a web-based application designed to facilitate the annotation of data. It provides an intuitive interface for users to label and categorize data efficiently. The project leverages modern web technologies and libraries such as React and TypeScript to ensure a smooth and responsive user experience.

Features

• User-friendly interface for data annotation
• Supports various data types and formats
• Real-time collaboration and updates
• Integration with popular data storage solutions
• Customizable annotation tools and workflows

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Usage

Getting Started

Prerequisites

Before getting started with annotator, ensure your runtime environment meets the following requirements:

• Programming Language: TypeScript
• Package Manager: Npm

Installation

Install annotator using one of the following methods:

Build from source:

1. Install the project dependencies:

Using npm  

❯ npm install @fruitfulai-ag/annotator

Usage

import { Annotator } from 'fruitful-annotator';

// Types can be found in src/model/annotator.interface.ts

interface Props {
  src: string;
  annotations: ImageAnnotation;
  setAnnotations: React.Dispatch<React.SetStateAction<ImageAnnotation>>;
  displayAnnotator: boolean;
}

<Annotator
    src={image}
    annotations={annotations}
    setAnnotations={setAnnotations}
    displayAnnotator={true}
/>