How dean-koro/shiori works
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: readerView.tsx Reader view · initAppStorage.ts Storage initialization · App.tsx App shell · libraryView.tsx Library view
Components 18
Application experience
- App shell
src/App.tsx - Library domain types
src/types/library.ts
Library and PDF
- Library view
src/features/library/libraryView.tsx - PDF import and covers
src/services/pdf/pdfImporter.ts
Reading features
- Reader view
src/features/reader/readerView.tsx - PDF page canvas
src/features/reader/PdfPageCanvas.tsx - Reader sidebar
src/features/reader/ReaderSidebar.tsx - Resume preview
src/features/reader/ResumeWelcomeModal.tsx - PDF search
src/services/pdf/pdfSearch.ts
Local persistence
- Books and series
src/services/db/booksRepo.ts - Reading progress
src/services/db/progressRepo.ts - Notes and glossary
src/services/db/notesRepo.ts - Storage initialization
src/services/storages/initAppStorage.ts - SQLite database
- Local book and cover files
Updates
- Update check and install
src/services/updater/checkForUpdates.ts
Other components
- Reader
- Update service
Connections 23
- Reader → App shell: opens
README.md - App shell → Storage initialization: initializes
src/App.tsx - App shell → Library view: shows library
src/App.tsx - App shell → Reader view: opens book
src/App.tsx - App shell → Update check and install: checks updates
src/App.tsx - Library view → PDF import and covers: imports PDFs
src/features/library/libraryView.tsx - Library view → Books and series: manages books
src/features/library/libraryView.tsx - PDF import and covers → Local book and cover files: writes PDFs and covers
src/services/pdf/pdfImporter.ts - Reader view → Local book and cover files: reads PDF
src/features/reader/readerView.tsx - Reader view → PDF page canvas: renders pages
src/features/reader/readerView.tsx - Reader view → Reader sidebar: shows sidebar
src/features/reader/readerView.tsx - Reader view → Resume preview: shows resume preview
src/features/reader/readerView.tsx - Reader view → Reading progress: saves progress
src/features/reader/readerView.tsx - Reader view → Notes and glossary: toggles bookmarks
src/features/reader/readerView.tsx - Reader sidebar → Notes and glossary: manages notes and glossary
src/features/reader/ReaderSidebar.tsx - Reader sidebar → PDF search: searches document
src/features/reader/ReaderSidebar.tsx - Resume preview → PDF page canvas: renders quick peek
src/features/reader/ResumeWelcomeModal.tsx - Storage initialization → SQLite database: loads database
src/services/storages/initAppStorage.ts - Storage initialization → Local book and cover files: creates app folders
src/services/storages/initAppStorage.ts - Books and series → Storage initialization: gets database
src/services/db/booksRepo.ts - Reading progress → Storage initialization: gets database
src/services/db/progressRepo.ts - Notes and glossary → Storage initialization: gets database
src/services/db/notesRepo.ts - Update check and install → Update service: checks and installs
README.md