Librium is a performance-focused web application for uploading, managing, and reading your personal ebook library online. Built as a Single Page Application (SPA) primarily for EPUBs, it delivers a fast and seamless reading experience directly in your browser, accessible from anywhere.
The project consists of:
- Frontend: A React application (built with Vite + TypeScript) providing the user interface.
- Backend: A Spring Boot application handling user authentication, book processing, storage management, and API endpoints.
Status: Active Development
Librium is currently under heavy active development and is not yet ready for production or general use. Features are incomplete, APIs might change, and stability is not guaranteed. Expect bugs and potential data loss. Use at your own risk!
*User-friendly installation instructions (including Docker setup) will be provided soon.
Even in its early stage, Librium offers several core functionalities:
- User Authentication: Secure registration and login using Spring Security JWT.
- EPUB Upload & Processing: Upload your
.epubfiles to your personal library. The backend parses metadata (title, author, ToC) and cover images. - Library Management:
- View your uploaded books with cover images (if available), titles, and authors.
- Download your original EPUB files.
- Delete books from your library.
- Web Reader:
- Read EPUB content directly in the browser.
- Navigate between chapters using Next/Previous controls or the Table of Contents drawer.
- Basic keyboard navigation (left/right arrows).
- Progress Syncing: Automatically saves and resumes your reading progress at the last visited chapter for each book.
- Theme Toggle: Switch between light and dark themes for the interface.
- Frontend: React 19, TypeScript, Vite, Tailwind CSS, DaisyUI
- Backend: Java 17+, Spring Boot 3, Spring Security (JWT), Spring Data JPA
- Database: PostgreSQL
- Parsing: Jsoup (HTML parsing for content), Java XML APIs (EPUB structure)
- Containerization: Docker, Docker Compose
- Deployment Example: Traefik (Reverse Proxy for HTTPS/Routing in
docker-compose.prod.yml)
This project is evolving. Some key areas planned for future development include:
- Enhanced Reader Experience: Font customization, line spacing/margins, scroll position saving, in-book search, progress indicators.
- Improved Library Management: Sorting, filtering, searching, collections/tagging.
- Performance & Scalability: Caching (e.g., Redis), optimizing EPUB parsing/storage.
- UI/UX Refinements: Intuitive controls, responsiveness, error/loading states.
- More Robust EPUB Parsing: Enhancing the EPUB parser for better compatibility and metadata extraction (potentially leveraging or adapting existing libraries).
- Broader Format Support: Investigating support for
.txtand potentially others. - External Source Integration: Exploring integration with sources like Project Gutenberg, Standard Ebooks, etc., for direct browsing and downloading.
- Simplified Deployment: Providing streamlined Docker configurations for easier self-hosting.
- Stability & Robustness: Comprehensive error handling, increased test coverage.
- Accessibility: Auditing and improvements.
(See SpringReader/docs/plan_todo.md for more granular details)
Given the early and active development stage, formal contributions are not the primary focus. However, if you encounter bugs or have specific feature suggestions, feel free to:
- Open an Issue: Describe the bug or enhancement request clearly on the GitHub repository's Issues page.
- Fork and Experiment: You're welcome to fork the repository and experiment, but be aware that the main branch may undergo significant changes.
This project is licensed under the Apache License 2.0. See the LICENSE file for details.