# adoocat/tez architecture

> Architecture diagram of the GitHub repository adoocat/tez, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/adoocat/tez
- Repository: https://github.com/adoocat/tez

## Overview

TEz is a local-first systematic literature review workbench, delivered through a web UI in a Tauri desktop app and a Python API backed by a local SQLite library. The principal workflow moves from federated search and file imports through screening, appraisal, and PRISMA/bibliography reporting; library management and reading support that work. The README documents these product stages, while sampled backend services and the application factory show selected internal calls and route registration. Several feature implementations were not sampled, so their links are documented or left unverified rather than inferred from filenames.

Main entry points: [`backend/src/tez/main.py`](https://github.com/adoocat/tez/blob/main/backend/src/tez/main.py) (HTTP application), [`backend/src/tez/modules/screening/service.py`](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/screening/service.py) (Screening), [`backend/src/tez/modules/search/service.py`](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/search/service.py) (Federated search), [`backend/src/tez/modules/library/paper_service.py`](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/library/paper_service.py) (Paper library)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["User experience"]
  node_webapp["Review workspace<br/>[App.tsx]"]
end

subgraph group_discovery["Discovery and library"]
  node_search["Federated search<br/>[service.py]"]
  node_providers["Academic sources<br/>[registry.py]"]
  node_imports["File imports"]
  node_library["Paper library<br/>[paper_service.py]"]
  node_files["PDF files"]
  node_reader["PDF reader<br/>[ReaderPage.tsx]"]
end

subgraph group_review["Review methods"]
  node_reviews["Review setup<br/>[service.py]"]
  node_screening["Screening<br/>[service.py]"]
  node_dual["Reviewer agreement<br/>[service.py]"]
  node_snowball["Citation snowballing"]
  node_grey["Grey literature"]
  node_quality["Quality appraisal<br/>[service.py]"]
  node_prisma["PRISMA reporting"]
  node_export["Bibliography export"]
end

subgraph group_platform["Local platform"]
  node_api["HTTP application<br/>[main.py]"]
  node_database[("SQLite library<br/>[db.py]")]
  node_jobs["Background jobs"]
  node_backup["Backup and restore"]
end

node_researcher(("Researcher"))

node_researcher -->|"uses"| node_webapp
node_webapp -.->|"requests"| node_api
node_api -->|"registers routes"| node_search
node_api -->|"registers routes"| node_reviews
node_api -->|"registers routes"| node_screening
node_api -->|"registers routes"| node_dual
node_api -->|"registers routes"| node_quality
node_api -.->|"registers routes"| node_imports
node_api -.->|"registers routes"| node_prisma
node_api -.->|"registers routes"| node_export
node_api -.->|"registers routes"| node_files
node_api -.->|"registers routes"| node_jobs
node_api -.->|"registers routes"| node_backup
node_search -->|"queries sources"| node_providers
node_search -->|"stores papers"| node_library
node_imports -.->|"adds records"| node_library
node_reviews -->|"provides review data"| node_screening
node_screening -->|"reads papers"| node_library
node_quality -->|"uses review data"| node_reviews
node_quality -->|"uses decisions"| node_screening
node_dual -->|"uses review data"| node_reviews
node_dual -->|"uses decisions"| node_screening
node_snowball -->|"reuses search"| node_search
node_snowball -->|"dispatches work"| node_jobs
node_screening -.->|"reads and writes"| node_database
node_library -.->|"reads and writes"| node_database
node_files -.->|"serves PDFs"| node_reader
node_search -.->|"records results"| node_database
node_researcher -->|"reads papers"| node_reader
node_researcher -->|"reviews flow"| node_prisma
node_researcher -->|"exports bibliography"| node_export
node_researcher -->|"finds citations"| node_snowball
node_researcher -->|"adds sources"| node_grey
node_researcher -->|"backs up library"| node_backup

click node_webapp "https://github.com/adoocat/tez/blob/main/apps/web/src/app/App.tsx"
click node_search "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/search/service.py"
click node_providers "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/search/providers/registry.py"
click node_imports "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/importers"
click node_library "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/library/paper_service.py"
click node_files "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/files"
click node_reader "https://github.com/adoocat/tez/blob/main/apps/web/src/features/reader/ReaderPage.tsx"
click node_reviews "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/reviews/service.py"
click node_screening "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/screening/service.py"
click node_dual "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/dual_screening/service.py"
click node_snowball "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/snowballing"
click node_grey "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/greylit"
click node_quality "https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/quality/service.py"
click node_prisma "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/prisma"
click node_export "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/export"
click node_api "https://github.com/adoocat/tez/blob/main/backend/src/tez/main.py"
click node_database "https://github.com/adoocat/tez/blob/main/backend/src/tez/core/db.py"
click node_jobs "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/jobs"
click node_backup "https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/backup"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_webapp toneBlue
class node_search,node_providers,node_imports,node_library,node_files,node_reader toneAmber
class node_reviews,node_screening,node_dual,node_snowball,node_grey,node_quality,node_prisma,node_export toneMint
class node_api,node_database,node_jobs,node_backup toneRose
class node_researcher toneIndigo
```

## Components

### User experience

- [Review workspace](https://github.com/adoocat/tez/blob/main/apps/web/src/app/App.tsx): `apps/web/src/app/App.tsx`

### Discovery and library

- [Federated search](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/search/service.py): `backend/src/tez/modules/search/service.py`
- [Academic sources](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/search/providers/registry.py): `backend/src/tez/modules/search/providers/registry.py`
- [File imports](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/importers): `backend/src/tez/modules/importers`
- [Paper library](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/library/paper_service.py): `backend/src/tez/modules/library/paper_service.py`
- [PDF files](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/files): `backend/src/tez/modules/files`
- [PDF reader](https://github.com/adoocat/tez/blob/main/apps/web/src/features/reader/ReaderPage.tsx): `apps/web/src/features/reader/ReaderPage.tsx`

### Review methods

- [Review setup](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/reviews/service.py): `backend/src/tez/modules/reviews/service.py`
- [Screening](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/screening/service.py): `backend/src/tez/modules/screening/service.py`
- [Reviewer agreement](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/dual_screening/service.py): `backend/src/tez/modules/dual_screening/service.py`
- [Citation snowballing](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/snowballing): `backend/src/tez/modules/snowballing`
- [Grey literature](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/greylit): `backend/src/tez/modules/greylit`
- [Quality appraisal](https://github.com/adoocat/tez/blob/main/backend/src/tez/modules/quality/service.py): `backend/src/tez/modules/quality/service.py`
- [PRISMA reporting](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/prisma): `backend/src/tez/modules/prisma`
- [Bibliography export](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/export): `backend/src/tez/modules/export`

### Local platform

- [HTTP application](https://github.com/adoocat/tez/blob/main/backend/src/tez/main.py): `backend/src/tez/main.py`
- [SQLite library](https://github.com/adoocat/tez/blob/main/backend/src/tez/core/db.py): `backend/src/tez/core/db.py`
- [Background jobs](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/jobs): `backend/src/tez/modules/jobs`
- [Backup and restore](https://github.com/adoocat/tez/tree/main/backend/src/tez/modules/backup): `backend/src/tez/modules/backup`

### Other components

- **Researcher**

## Connections

- Researcher → Review workspace: uses (evidence: `README.md`)
- Review workspace → HTTP application: requests
- HTTP application → Federated search: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Review setup: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Screening: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Reviewer agreement: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Quality appraisal: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → File imports: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → PRISMA reporting: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Bibliography export: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → PDF files: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Background jobs: registers routes (evidence: `backend/src/tez/main.py`)
- HTTP application → Backup and restore: registers routes (evidence: `backend/src/tez/main.py`)
- Federated search → Academic sources: queries sources (evidence: `backend/src/tez/modules/search/service.py`)
- Federated search → Paper library: stores papers (evidence: `backend/src/tez/modules/search/service.py`)
- File imports → Paper library: adds records
- Review setup → Screening: provides review data (evidence: `backend/src/tez/modules/screening/service.py`)
- Screening → Paper library: reads papers (evidence: `backend/src/tez/modules/screening/service.py`)
- Quality appraisal → Review setup: uses review data (evidence: `backend/src/tez/modules/quality/service.py`)
- Quality appraisal → Screening: uses decisions (evidence: `backend/src/tez/modules/quality/service.py`)
- Reviewer agreement → Review setup: uses review data (evidence: `backend/src/tez/modules/dual_screening/service.py`)
- Reviewer agreement → Screening: uses decisions (evidence: `backend/src/tez/modules/dual_screening/service.py`)
- Citation snowballing → Federated search: reuses search (evidence: `backend/src/tez/modules/snowballing/service.py`)
- Citation snowballing → Background jobs: dispatches work (evidence: `backend/src/tez/modules/snowballing/service.py`)
- Screening → SQLite library: reads and writes (evidence: `backend/src/tez/modules/screening/service.py`)
- Paper library → SQLite library: reads and writes (evidence: `backend/src/tez/modules/library/paper_service.py`)
- PDF files → PDF reader: serves PDFs
- Federated search → SQLite library: records results (evidence: `backend/src/tez/modules/search/service.py`)
- Researcher → PDF reader: reads papers (evidence: `README.md`)
- Researcher → PRISMA reporting: reviews flow (evidence: `README.md`)
- Researcher → Bibliography export: exports bibliography (evidence: `README.md`)
- Researcher → Citation snowballing: finds citations (evidence: `README.md`)
- Researcher → Grey literature: adds sources (evidence: `README.md`)
- Researcher → Backup and restore: backs up library (evidence: `README.md`)
