@ghentcdh/annotation-api

Annotation Editor

Monorepo for W3C-compliant annotation editing. Provides a NestJS API module for serving annotation definitions, a shared core library for types and validation, and a Vue 3 editor component for creating and managing annotations on text sources.

Documentation: https://ghentcdh.github.io/annotation-editor/

Packages

Getting started

See the documentation for installation, configuration, and usage guides.

Architecture

┌─────────────────────┐
│  annotation-vue     │  Vue 3 editor + preview components
│  (frontend)         │
└────────┬────────────┘
         │ uses types from
┌────────▼────────────┐
│  annotation-core    │  Shared types, Zod schemas, config
└────────┬────────────┘
         │ used by
┌────────▼────────────┐
│  annotation-api     │  NestJS module (serves definitions)
│  (backend)          │
└─────────────────────┘

• annotation-core — shared dependency used by both frontend and backend
• annotation-api — loads annotation definitions from JSON files and serves them via REST
• annotation-vue — renders sources and annotations, provides CRUD UI using the W3C annotation standard via @ghentcdh/w3c-utils

Development

# Install dependencies
pnpm install

# Lint
pnpm nx affected -t lint --base=origin/main

# Test
pnpm nx affected -t test --base=origin/main

# Type check
pnpm nx affected -t typecheck --base=origin/main

License

MIT — see LICENSE.

Credits

Bo Vandersteene, Ghent University.

Development by Ghent Centre for Digital Humanities — Ghent University. Funded by the GhentCDH research projects.