anjesh / carbondream

Reactjs Annotation Components

carbondream

Reactjs Annotation Engine

Carbondream is an annotation engine written purely in ReactJS. It was inspired by Annotator and heavily borrows from the UX.

Using it

To use Carbondream:

• Install the component through NPM

• Require it

• Pass it a list of annotations, a save handler, and a delete handler

    <Container
      annotations={annotations}
      onSave={this.handleAnnotationSave}
      onDelete={this.handleAnnotationDelete}
    />
  

Check out test/demo.jsx for a simple implementation using RefluxJS with local storage.

Contributing

First, setup your local environment:

git clone [email protected]:ZeroarcSoftware/carbondream.git
cd carbondream
npm install

Next, build the project (for use in a npm link scenario):

npm run build

To run the demo (uses browserify):

npm run demo-build

Or to watch for changes:

npm run demo-watch