Annotorious 3: write a basic 'Getting Started' guide for React

[rsimon]

Important this issue is about Annotorious v3, which is currently a separate branch in this repository.

Annotorious is about to get a new major release. Annotorious 3 is a complete re-write, and will fix many of the issues that people had with the previous version. In particular, it will simplify integration with different JavaScript frameworks.

At the moment, however, Annotorious 3 is almost completely undocumented. If anyone wants to help with testing & documentation, that would be amazing.

Task: make a test installation, set up a minimal React starter project, and document the "Getting Started" steps. Ideally as a markdown page in the docs folder. Since there is no documentation yet, you will have to dig into the code a little. You can use the test example as a starting point:

https://github.com/annotorious/annotorious/tree/3.x/packages/annotorious-react/test

[BrunoWinck]

I can try to work on this one

[rsimon]

That would be fantastic, thanks!

[rsimon]

By the way: a small conversation about the new React binding module has developed here:
#202 (comment)

It includes some basic pointers on where & how to get started.

[akash0708]

Hello, are you guys participating in Hacktoberfest 2023?

[rsimon]

Yes, participating in Hacktoberfest 2023 👍

[rsimon]

I'm starting this here:
https://github.com/annotorious/annotorious/blob/main/docs/react/image-annotator.md