labelbee

Introduction to LabelBee

LabelBee is a project designed specifically for annotation, focusing on rendering annotation experiences and providing a component library to facilitate the rapid setup of annotation applications. The goal is to simplify and enhance the annotation process for developers and users alike.

Key Features

1. Plug-and-Play Simplicity: LabelBee is designed to help users create annotation applications with minimal configuration. This feature makes it highly accessible and convenient for developers who want to implement annotation capabilities quickly.

2. Separated Rendering: The rendering module of LabelBee can be used independently. This flexibility allows developers to integrate only the rendering component into their existing systems if needed, enhancing the modularity of their projects.

Installation

Getting started with LabelBee is straightforward, with support for both npm and yarn. To install, users can run the following commands:

For npm:

npm install @labelbee/lb-annotation
npm install @labelbee/lb-components

For yarn:

yarn add @labelbee/lb-annotation
yarn add @labelbee/lb-components

Usage

LabelBee provides an easy-to-follow example to help users get started quickly. Below is a basic setup for integrating the annotation view into a React application:

import React from 'react';
import ReactDOM from 'react-dom';
import { AnnotationView } from '@labelbee/lb-components';

const src = ''; // Accessible image path

const DefaultComponent = () => {
  return (
    <AnnotationView
     src={src}
   />
  )
}

ReactDOM.render(<App />, document.querySelector('#app'));

In this example, the AnnotationView component is utilized to display annotations on images. Users should replace the src variable with the path to their desired image.

Documentation

LabelBee offers comprehensive documentation to help users navigate and leverage its functionalities:

• For details on the annotation library, users can refer to the lb-Annotation documentation.
• For the component library, the lb-components documentation is available.
• A quick demo is provided for users to see LabelBee in action.

Additional Resources

• A related project, LabelBee-Client, is available for those interested in exploring more about the LabelBee ecosystem.

License

LabelBee is released under the Apache 2.0 license, ensuring openness and encouraging contributions from the community.