https://github.com/xyaman/lumi-reader
Epub reader focused in Japanese books. Aiming to be fast and lightweight. Built with SolidJS and Ruby on Rails.
https://github.com/xyaman/lumi-reader
epub japanese rails reader ruby solidjs typescript
Last synced: 3 months ago
JSON representation
Epub reader focused in Japanese books. Aiming to be fast and lightweight. Built with SolidJS and Ruby on Rails.
- Host: GitHub
- URL: https://github.com/xyaman/lumi-reader
- Owner: xyaman
- License: agpl-3.0
- Created: 2025-04-30T13:47:14.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-09-28T09:54:42.000Z (7 months ago)
- Last Synced: 2025-09-28T11:43:17.281Z (7 months ago)
- Topics: epub, japanese, rails, reader, ruby, solidjs, typescript
- Language: TypeScript
- Homepage: https://lumireader.app
- Size: 1.31 MB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lumi Reader (Beta)
Lumi Reader is a modern, open-source web application designed to provide a feature-rich e-reading and social (SNS) experience.
## Features
* **Personal Library**: Organize and manage your e-book collection locally.
* **Customizable Reader**: Personalize your reading experience with themes and settings.
* **Session Tracking**: Track your reading sessions and view statistics.
* **Social Features**: Connect with other readers, share your progress, and discover new books.
* **Book Sync**: Seamlessly sync your books and reading progress across devices.
* **Authentication**: User accounts with different subscription tiers.
* **PWA with Offline Support**: Works without an internet connection.
* **Yomitan-compatible**: Works with browser dictionaries like [Yomitan](https://yomitan.wiki/).
## Roadmap
- Improve epub support to all languages (current focus is japanese).
## Current e-book format support
- EPUB
## Architecture
This project is built with a modern tech stack and is split into two main parts. For more specific technical details, please see the README file inside each directory.
* **Frontend:** A responsive user interface built with SolidJS, TypeScript, and Bun.
* **Backend:** The server-side logic and API that powers the application.
## Contributing
We welcome contributions! If you have an idea for a new feature or have found an issue, please **create a discussion first** before submitting a pull request or opening an issue.
This allows us to talk about the proposed changes and ensure they align with the project's goals.
## License
Lumi Reader is distributed under the **AGPL-3.0 license**.
See the included `LICENSE` file for more information.
## Support the Project
If you find Lumi Reader useful and want to support its development, please consider becoming a patron. Your donation helps cover server costs and allows me to dedicate more time to building new features and improving the app.
[Become a Patron](https://www.patreon.com/lumireader)