How notesjor/ids.quickannotator works
Project type and purpose
• This is a modular, full-stack .NET and JavaScript system for text-corpus annotation.
• It spans back-end (REST API), desktop clients (WinForms/WPF), command-line tools (console apps), and a web front end (Nuxt.js/Vue).
File structure
• Top-level folders each represent a self-contained module or service:
• IDS.QuickAnnotator.API (ASP.NET Core REST API)
• IDS.QuickAnnotator.Client (desktop annotator UI)
• IDS.QuickAnnotator.Client.Selector (desktop pre-selection UI)
• IDS.QuickAnnotator.Web (Nuxt.js/Vue web client)
• IDS.QuickAnnotator.CorpusPreSampler, Processor, QafSampler (console-app data preparation modules)
• IDS.QuickAnnotator.Tool4.* (various console-app analysis & conversion tools)
• Configuration and publish profiles (.csproj, app.config, launchSettings.json) indicate deployment targets (Linux, RaspberryPI).
• The Web module uses package.json, nuxt.config.js, and Vue folder conventions.
README for additional insights
• The README confirms each module’s role in the overall annotation workflow:
• Data ingestion & formatting (Processor, QafSampler, CorpusPreSampler)
• Pre-selection (Client.Selector)
• Annotation (Client desktop & Web)
• Post-processing & analysis (Tool4.*)
• Storage and coordination via the central REST API.
Elements
• Clear labels for each module (use the exact project names).
• From data sources → preparation modules
• Preparation modules → API/DB
• API → Clients & Tools
• Tools → External outputs (reports, converted corpora)