# dean-koro/shiori architecture

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

- Interactive diagram: https://gitdiagram.com/dean-koro/shiori
- Repository: https://github.com/dean-koro/shiori

## Overview

Shiori is an offline desktop PDF novel reader. The main workflow initializes local storage, imports PDFs into the library, opens a volume in the reader, and persists reading progress and notes so the reader can resume later. The graph preserves the documented series, reading modes, resume preview, notes/glossary, PDF search, export, and update capabilities. Some connections rely on SOURCE INDEX imports or README statements; unsampled implementation details are not inferred.

Main entry points: [`src/features/reader/readerView.tsx`](https://github.com/dean-koro/shiori/blob/main/src/features/reader/readerView.tsx) (Reader view), [`src/services/storages/initAppStorage.ts`](https://github.com/dean-koro/shiori/blob/main/src/services/storages/initAppStorage.ts) (Storage initialization), [`src/App.tsx`](https://github.com/dean-koro/shiori/blob/main/src/App.tsx) (App shell), [`src/features/library/libraryView.tsx`](https://github.com/dean-koro/shiori/blob/main/src/features/library/libraryView.tsx) (Library view)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Application experience"]
  node_app["App shell<br/>[App.tsx]"]
  node_types["Library domain types<br/>[library.ts]"]
end

subgraph group_library["Library and PDF"]
  node_library_view["Library view<br/>[libraryView.tsx]"]
  node_pdf_import["PDF import and covers<br/>[pdfImporter.ts]"]
end

subgraph group_reading["Reading features"]
  node_reader_view["Reader view<br/>[readerView.tsx]"]
  node_page_canvas["PDF page canvas<br/>[PdfPageCanvas.tsx]"]
  node_reader_sidebar["Reader sidebar<br/>[ReaderSidebar.tsx]"]
  node_resume_modal["Resume preview"]
  node_pdf_search["PDF search<br/>[pdfSearch.ts]"]
end

subgraph group_persistence["Local persistence"]
  node_books_repo["Books and series<br/>[booksRepo.ts]"]
  node_progress_repo["Reading progress<br/>[progressRepo.ts]"]
  node_notes_repo["Notes and glossary<br/>[notesRepo.ts]"]
  node_storage["Storage initialization<br/>[initAppStorage.ts]"]
  node_sqlite[("SQLite database")]
  node_app_files["Local book and cover files"]
end

subgraph group_updates["Updates"]
  node_updater["Update check and install<br/>[checkForUpdates.ts]"]
end

node_user(("Reader"))
node_update_service["Update service"]

node_user -->|"opens"| node_app
node_app -->|"initializes"| node_storage
node_app -->|"shows library"| node_library_view
node_app -->|"opens book"| node_reader_view
node_app -->|"checks updates"| node_updater
node_library_view -->|"imports PDFs"| node_pdf_import
node_library_view -->|"manages books"| node_books_repo
node_pdf_import -->|"writes PDFs and covers"| node_app_files
node_reader_view -->|"reads PDF"| node_app_files
node_reader_view -->|"renders pages"| node_page_canvas
node_reader_view -->|"shows sidebar"| node_reader_sidebar
node_reader_view -->|"shows resume preview"| node_resume_modal
node_reader_view -->|"saves progress"| node_progress_repo
node_reader_view -->|"toggles bookmarks"| node_notes_repo
node_reader_sidebar -->|"manages notes and glossary"| node_notes_repo
node_reader_sidebar -->|"searches document"| node_pdf_search
node_resume_modal -->|"renders quick peek"| node_page_canvas
node_storage -->|"loads database"| node_sqlite
node_storage -->|"creates app folders"| node_app_files
node_books_repo -->|"gets database"| node_storage
node_progress_repo -->|"gets database"| node_storage
node_notes_repo -->|"gets database"| node_storage
node_updater -.->|"checks and installs"| node_update_service

click node_app "https://github.com/dean-koro/shiori/blob/main/src/App.tsx"
click node_library_view "https://github.com/dean-koro/shiori/blob/main/src/features/library/libraryView.tsx"
click node_pdf_import "https://github.com/dean-koro/shiori/blob/main/src/services/pdf/pdfImporter.ts"
click node_books_repo "https://github.com/dean-koro/shiori/blob/main/src/services/db/booksRepo.ts"
click node_reader_view "https://github.com/dean-koro/shiori/blob/main/src/features/reader/readerView.tsx"
click node_page_canvas "https://github.com/dean-koro/shiori/blob/main/src/features/reader/PdfPageCanvas.tsx"
click node_reader_sidebar "https://github.com/dean-koro/shiori/blob/main/src/features/reader/ReaderSidebar.tsx"
click node_resume_modal "https://github.com/dean-koro/shiori/blob/main/src/features/reader/ResumeWelcomeModal.tsx"
click node_pdf_search "https://github.com/dean-koro/shiori/blob/main/src/services/pdf/pdfSearch.ts"
click node_progress_repo "https://github.com/dean-koro/shiori/blob/main/src/services/db/progressRepo.ts"
click node_notes_repo "https://github.com/dean-koro/shiori/blob/main/src/services/db/notesRepo.ts"
click node_storage "https://github.com/dean-koro/shiori/blob/main/src/services/storages/initAppStorage.ts"
click node_types "https://github.com/dean-koro/shiori/blob/main/src/types/library.ts"
click node_updater "https://github.com/dean-koro/shiori/blob/main/src/services/updater/checkForUpdates.ts"

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_app,node_types toneBlue
class node_library_view,node_pdf_import toneAmber
class node_reader_view,node_page_canvas,node_reader_sidebar,node_resume_modal,node_pdf_search toneMint
class node_books_repo,node_progress_repo,node_notes_repo,node_storage,node_sqlite,node_app_files toneRose
class node_updater,node_user,node_update_service toneIndigo
```

## Components

### Application experience

- [App shell](https://github.com/dean-koro/shiori/blob/main/src/App.tsx): `src/App.tsx`
- [Library domain types](https://github.com/dean-koro/shiori/blob/main/src/types/library.ts): `src/types/library.ts`

### Library and PDF

- [Library view](https://github.com/dean-koro/shiori/blob/main/src/features/library/libraryView.tsx): `src/features/library/libraryView.tsx`
- [PDF import and covers](https://github.com/dean-koro/shiori/blob/main/src/services/pdf/pdfImporter.ts): `src/services/pdf/pdfImporter.ts`

### Reading features

- [Reader view](https://github.com/dean-koro/shiori/blob/main/src/features/reader/readerView.tsx): `src/features/reader/readerView.tsx`
- [PDF page canvas](https://github.com/dean-koro/shiori/blob/main/src/features/reader/PdfPageCanvas.tsx): `src/features/reader/PdfPageCanvas.tsx`
- [Reader sidebar](https://github.com/dean-koro/shiori/blob/main/src/features/reader/ReaderSidebar.tsx): `src/features/reader/ReaderSidebar.tsx`
- [Resume preview](https://github.com/dean-koro/shiori/blob/main/src/features/reader/ResumeWelcomeModal.tsx): `src/features/reader/ResumeWelcomeModal.tsx`
- [PDF search](https://github.com/dean-koro/shiori/blob/main/src/services/pdf/pdfSearch.ts): `src/services/pdf/pdfSearch.ts`

### Local persistence

- [Books and series](https://github.com/dean-koro/shiori/blob/main/src/services/db/booksRepo.ts): `src/services/db/booksRepo.ts`
- [Reading progress](https://github.com/dean-koro/shiori/blob/main/src/services/db/progressRepo.ts): `src/services/db/progressRepo.ts`
- [Notes and glossary](https://github.com/dean-koro/shiori/blob/main/src/services/db/notesRepo.ts): `src/services/db/notesRepo.ts`
- [Storage initialization](https://github.com/dean-koro/shiori/blob/main/src/services/storages/initAppStorage.ts): `src/services/storages/initAppStorage.ts`
- **SQLite database**
- **Local book and cover files**

### Updates

- [Update check and install](https://github.com/dean-koro/shiori/blob/main/src/services/updater/checkForUpdates.ts): `src/services/updater/checkForUpdates.ts`

### Other components

- **Reader**
- **Update service**

## Connections

- Reader → App shell: opens (evidence: `README.md`)
- App shell → Storage initialization: initializes (evidence: `src/App.tsx`)
- App shell → Library view: shows library (evidence: `src/App.tsx`)
- App shell → Reader view: opens book (evidence: `src/App.tsx`)
- App shell → Update check and install: checks updates (evidence: `src/App.tsx`)
- Library view → PDF import and covers: imports PDFs (evidence: `src/features/library/libraryView.tsx`)
- Library view → Books and series: manages books (evidence: `src/features/library/libraryView.tsx`)
- PDF import and covers → Local book and cover files: writes PDFs and covers (evidence: `src/services/pdf/pdfImporter.ts`)
- Reader view → Local book and cover files: reads PDF (evidence: `src/features/reader/readerView.tsx`)
- Reader view → PDF page canvas: renders pages (evidence: `src/features/reader/readerView.tsx`)
- Reader view → Reader sidebar: shows sidebar (evidence: `src/features/reader/readerView.tsx`)
- Reader view → Resume preview: shows resume preview (evidence: `src/features/reader/readerView.tsx`)
- Reader view → Reading progress: saves progress (evidence: `src/features/reader/readerView.tsx`)
- Reader view → Notes and glossary: toggles bookmarks (evidence: `src/features/reader/readerView.tsx`)
- Reader sidebar → Notes and glossary: manages notes and glossary (evidence: `src/features/reader/ReaderSidebar.tsx`)
- Reader sidebar → PDF search: searches document (evidence: `src/features/reader/ReaderSidebar.tsx`)
- Resume preview → PDF page canvas: renders quick peek (evidence: `src/features/reader/ResumeWelcomeModal.tsx`)
- Storage initialization → SQLite database: loads database (evidence: `src/services/storages/initAppStorage.ts`)
- Storage initialization → Local book and cover files: creates app folders (evidence: `src/services/storages/initAppStorage.ts`)
- Books and series → Storage initialization: gets database (evidence: `src/services/db/booksRepo.ts`)
- Reading progress → Storage initialization: gets database (evidence: `src/services/db/progressRepo.ts`)
- Notes and glossary → Storage initialization: gets database (evidence: `src/services/db/notesRepo.ts`)
- Update check and install → Update service: checks and installs (evidence: `README.md`)
