bookorbit
BookOrbit: Your Reading Space
Discover how BookOrbit prioritizes metadata providers using a three-tier system merging global defaults with library-specific overrides for efficient metadata fetching.
KOReader Plugin Source Code Location in BookOrbit: Complete Server-Side Module GuideFind the KOReader plugin source code in the bookorbit/bookorbit repository at server/src/modules/koreader. This NestJS module guides you through its server-side implementation.
BookOrbit Sync Module Structure: Complete Guide to the Kobo ImplementationExplore the BookOrbit sync module structure for Kobo. Discover controllers, services, DTOs, and guards within the Kobo implementation. Understand the full Kobo sync protocol.
BookOrbit WebSocket Adapter Setup: Location and Configuration in NestJSDiscover the WebSocket adapter setup in BookOrbit's NestJS application. Learn where to locate and configure Socket.IO for real-time communication within the server/src/main.ts file.
How SmartScopeService Handles Ownership Checks in BookOrbitDiscover how SmartScopeService handles ownership checks in BookOrbit using assertReadAccess and assertWriteAccess guard methods for secure data operations. Learn more!
How Rule-Based Filters for Smart Scopes Work in BookOrbitDiscover how BookOrbit Smart Scopes leverage rule-based filters with JSONB and GroupRule objects to dynamically filter book collections using logical AND/OR joins. Learn more!
How Manual Collections Work in BookOrbit: A Complete Technical GuideExplore how BookOrbit manages manual collections with a technical guide detailing ownership-based permissions, CRUD, reordering, and bulk management in this NestJS module.
How BookOrbit Implements Smart Scopes for Dynamic CollectionsDiscover how BookOrbit uses Smart Scopes and JSON GroupRule objects in PostgreSQL to create dynamic, self-updating collections, avoiding static book ID lists.
BOOKS_PATH Environment Variable in BookOrbit: Complete Configuration GuideUnderstand the BOOKS_PATH environment variable in BookOrbit. Learn how it defines your e-book library's root directory for seamless file management and synchronization. Get the complete guide.
How to Configure Library Settings in BookOrbit: REST API and Validation GuideConfigure BookOrbit library settings using the REST API. Send a PATCH request to update library details, validated by UpdateLibraryDto and persisted with Drizzle ORM.
How BookOrbit Implements Library Isolation with Per-Library FoldersDiscover how BookOrbit achieves robust library isolation using per-library folders and multi-layer ownership checks. Learn about its secure design for your data.
How Are Permissions Enforced in the BookOrbit Backend?Discover how BookOrbit enforces API permissions using a custom decorator, a global PermissionGuard, and user-scoped ownership checks for secure access to REST endpoints.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" 
Maintain an open-source project? Get it listed too →