@gliff-ai/annotate

gliff.ai ANNOTATE

This repository contains the Open Source source code for gliff.ai's ANNOTATE user interface. This user interface is just one part of gliff.ai's growing MLOps platform. ANNOTATE allows domain experts to annotate multidimensional images for developing imaging AI products. When used as part of gliff.ai's full platform ANNOTATE provides just one step in developing production-quality imaging AI whilst satisfying any relevant regulatory frameworks.

User documentation will be available soon.

Technical documentation will be available soon.

Installation

We recommend using the docker-compose.yml provided in the repository for quick and easy local instances with Docker Compose.

Development

Frontend code should be written in Typescript and transpiled using the options in tsconfig.json. Frontend code should be distributed using the npm registry. NPM should be used for package management.

npm run serve will run a local webpack developer server for quick access.

Please follow gliff.ai's Community Guidelines when contributing to this codebase.

Linting and formatting

Code should be linted with ESLint using .eslintrc.js and formatted with Prettier. HTML + CSS, mark-up and mark-down should all be formatted using prettier.

npm run lint will lint the codebase.

We also provide a pre-commit config for running a variety of linters locally on commit.

Our GitHub Actions will also lint any pull requests before they're merged.

Testing

Code should be tested using Jest and React Testing Library.

npm run test will run any existing tests in our codebase.

We also provide a pre-commit config for running a tests locally before a push.

Our GitHub Actions will also test any pull requests before they're merged.

Continuous integration

Pre-commit actions should be configured in .pre-commit-config.yaml.

GitHub Actions should be included under .github/workflows.

License

This code is licensed under a GNU AGPLv3 license. Our reasons for this will be published on our website soon.