About this project

Tome is a self-hosted book tracking web application that integrates directly with Calibre's database to provide reading progress tracking, status management, and streak functionality. It is designed to give users durable ownership of their reading history, with data stored locally and under their control. Key features include: - **Calibre Integration**: Automatically syncs your existing Calibre library by reading from and writing to Calibre's metadata.db. - **Reading Progress Tracking**: Track progress by page count or percentage, with history. - **Reading Streaks**: Daily streak tracking with configurable goals and analytics. - **Book Status Management**: Organize books by status (To Read, Read Next, Reading, Read, DNF) and support rereads while preserving previous reading sessions. - **Tag Management**: Remove tags from many books in one click, merge tags, and bulk delete tags. - **Statistics Dashboard**: Comprehensive reading statistics. - **Annual Goals**: Set and track annual reading goals. - **OPDS Catalog**: Support for OPDS to download books on the go. - **Self-Hosted**: Full control over data with no external dependencies. For production deployment, refer to the deployment guide in the docs. For local development, install dependencies with bun, configure the environment, run database migrations, optionally seed the database, and start the development server. Note: Tome reads from and writes to Calibre's metadata.db. Concurrent writes (e.g., editing tags or ratings in Tome while Calibre is running) can lead to database locks or unpredictable results. Read-only access is safe. The project is under active development, with a roadmap available on GitHub. Contributions are welcome; please review the architecture documentation, project constitution, and testing guide before contributing. The project is licensed under the MIT license.