README.md

pianno: The Pimega Annotator

A simple tool to help you annotate pimega images.

User guide and documentation

For a complete guide with examples and documentation, please visit the docs.

Note: the docs page is currently hosted at https://pianno.lnls.br/uwu, which is an internal server at CNPEM. If you are not at CNPEM, you can run the docs page locally by following the instructions below.

Run locally

You build the app yourself and run it locally by running the docker container with:

docker compose up --build

Then, open http://localhost:3000 with your browser to see the result. This will also start the docs page at http://localhost:4321.

or simply pull it from the registry:

docker pull ghcr.io/cnpem/cnpem/pianno:main
docker run -p 3000:3000 ghcr.io/cnpem/cnpem/pianno:main

The docs page is also available in the registry:

docker pull ghcr.io/cnpem/cnpem/pianno-docs:main
docker run -p 4321:3000 ghcr.io/cnpem/cnpem/pianno-docs:main

Developers

Getting Started

One can run the development mode with the following commands:

pnpm install
pnpm dev

Then, open http://localhost:3000 with your browser to see the result. This will also start the docs page at http://localhost:4321/uwu.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.