https://github.com/cnpem/pianno

Pimega Annotator
https://github.com/cnpem/pianno

Last synced: about 1 month ago
JSON representation

Pimega Annotator

• Host: GitHub
• URL: https://github.com/cnpem/pianno
• Owner: cnpem
• License: gpl-3.0
• Created: 2023-08-10T18:13:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-08T22:18:44.000Z (10 months ago)
• Last Synced: 2024-04-10T01:15:21.487Z (10 months ago)
• Language: TypeScript
• Homepage:
• Size: 112 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://pianno.lnls.br/uwu).

> Note: the docs page is currently hosted at [https://pianno.lnls.br/uwu](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:

```bash

docker compose up --build

```

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

or simply pull it from the registry:

```bash

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:

```bash

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:

```bash

pnpm install

pnpm dev

```

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

## License

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