Skip to content

xyaman/lumi-reader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

435 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

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

About

Epub reader focused in Japanese books. Aiming to be fast and lightweight. Built with SolidJS and Ruby on Rails.

Topics

Resources

License

Stars

29 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors