# notesjor/ids.quickannotator architecture

> Architecture diagram of the GitHub repository notesjor/ids.quickannotator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/notesjor/ids.quickannotator
- Repository: https://github.com/notesjor/ids.quickannotator

## Overview

##### 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)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Data Sources
    ExternalData["External Data Sources"]:::datasource

    %% Data Preparation Services
    subgraph "Data Preparation Services"
        direction TB
        CorpusPreSampler["IDS.QuickAnnotator.CorpusPreSampler"]:::backend
        Processor["IDS.QuickAnnotator.Processor"]:::backend
        QafSampler["IDS.QuickAnnotator.QafSampler"]:::backend
    end

    ExternalData -->|“raw corpora”| CorpusPreSampler
    ExternalData -->|“raw corpora”| Processor
    ExternalData -->|“raw corpora”| QafSampler

    %% Central REST API
    API["IDS.QuickAnnotator.API"]:::backend
    Model["API Models (Model)"]:::storage
    Database["Database"]:::db

    CorpusPreSampler -->|“file I/O”| API
    Processor -->|“file I/O”| API
    QafSampler -->|“file I/O”| API

    API -->|“uses models”| Model
    API -->|“DB access”| Database

    %% Desktop Clients
    subgraph "Desktop Clients"
        direction TB
        AnnotatorClient["IDS.QuickAnnotator.Client"]:::desktop
        SelectorClient["IDS.QuickAnnotator.Client.Selector"]:::desktop
    end

    AnnotatorClient -->|“HTTP/REST”| API
    SelectorClient -->|“HTTP/REST”| API

    %% Web Client
    WebClient["IDS.QuickAnnotator.Web"]:::web
    WebClient -->|“HTTP/REST”| API

    %% Analysis & Conversion Tools
    subgraph "Analysis & Conversion Tools"
        direction TB
        ApplyFixes["Tool4.ApplyAnnotatorFixes"]:::backend
        CalcDiff["Tool4.CalcDiff"]:::backend
        ConvertCorpus["Tool4.ConvertToCorpus"]:::backend
        ConvertJournal["Tool4.ConvertToJournal"]:::backend
        DominicSchmitz["Tool4.DominicSchmitz"]:::backend
        FindMatch["Tool4.FindMatchSentences"]:::backend
        OnlyAnnotatedBy["Tool4.OnlyAnnotatedBy"]:::backend
        RemoveAnnotator["Tool4.RemoveAnnotator"]:::backend
    end

    ApplyFixes -->|“HTTP/REST”| API
    CalcDiff -->|“HTTP/REST”| API
    ConvertCorpus -->|“HTTP/REST”| API
    ConvertJournal -->|“HTTP/REST”| API
    DominicSchmitz -->|“HTTP/REST”| API
    FindMatch -->|“HTTP/REST”| API
    OnlyAnnotatedBy -->|“HTTP/REST”| API
    RemoveAnnotator -->|“HTTP/REST”| API

    %% External Outputs
    ExternalOutputs["External Outputs (Reports, Converted Corpora)"]:::datasink
    ApplyFixes -->|“reports”| ExternalOutputs
    CalcDiff -->|“diffs”| ExternalOutputs
    ConvertCorpus -->|“corpora”| ExternalOutputs
    ConvertJournal -->|“journals”| ExternalOutputs
    DominicSchmitz -->|“outputs”| ExternalOutputs
    FindMatch -->|“matches”| ExternalOutputs
    OnlyAnnotatedBy -->|“filters”| ExternalOutputs
    RemoveAnnotator -->|“cleaned corpora”| ExternalOutputs

    %% Click Events
    click CorpusPreSampler "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.CorpusPreSampler/Program.cs"
    click Processor "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Processor/Program.cs"
    click QafSampler "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.QafSampler/Program.cs"
    click API "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.API/IDS.QuickAnnotator.API.csproj"
    click Model "https://github.com/notesjor/ids.quickannotator/tree/main/IDS.QuickAnnotator.API/Model"
    click AnnotatorClient "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Client/IDS.QuickAnnotator.Client.csproj"
    click SelectorClient "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Client.Selector/IDS.QuickAnnotator.Client.Selector.csproj"
    click WebClient "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Web/nuxt.config.js"
    click ApplyFixes "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.ApplyAnnotatorFixes/Program.cs"
    click CalcDiff "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.CalcDiff/Program.cs"
    click ConvertCorpus "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.ConvertToCorpus/Program.cs"
    click ConvertJournal "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.ConvertToJournal/Program.cs"
    click DominicSchmitz "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.DominicSchmitz/Program.cs"
    click FindMatch "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.FindMatchSentences/Program.cs"
    click OnlyAnnotatedBy "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.OnlyAnnotatedBy/Program.cs"
    click RemoveAnnotator "https://github.com/notesjor/ids.quickannotator/blob/main/IDS.QuickAnnotator.Tool4.RemoveAnnotator/Program.cs"

    %% Styles
    classDef backend fill:#aed6f1,stroke:#1f618d,color:#1b2631
    classDef desktop fill:#a9dfbf,stroke:#196f3d,color:#1b2631
    classDef web fill:#f9e79f,stroke:#b9770e,color:#1b2631
    classDef datasource fill:#d5d8dc,stroke:#566573,color:#1b2631
    classDef db fill:#85c1e9,stroke:#1a5276,color:#1b2631
    classDef datasink fill:#d5f5e3,stroke:#229954,color:#1b2631
    classDef storage fill:#d6eaf8,stroke:#154360,color:#1b2631
```
