Skip to content

A cross platform desktop reading app, based on the Readium Desktop toolkit

License

Notifications You must be signed in to change notification settings

Youngchan-91/thorium-reader

This branch is 1 commit ahead of, 797 commits behind edrlab/thorium-reader:develop.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b259c02 · Mar 21, 2023
Jan 27, 2023
Feb 12, 2021
Nov 27, 2022
Apr 17, 2019
Oct 31, 2017
Oct 10, 2019
Nov 29, 2022
Mar 1, 2023
Mar 21, 2023
Jan 21, 2022
May 15, 2017
Feb 12, 2021
Feb 26, 2021
Mar 19, 2018
Mar 30, 2017
Sep 1, 2017
Feb 26, 2021
Feb 12, 2021
Aug 8, 2022
Jul 7, 2017
Sep 5, 2019
Mar 20, 2017
May 30, 2022
Feb 26, 2021
Sep 14, 2022
Mar 14, 2023
Mar 14, 2023
Nov 12, 2021
Aug 6, 2019
Feb 11, 2022
Jan 21, 2022
Aug 9, 2022
Aug 9, 2022
Nov 15, 2022
Aug 9, 2022
Nov 15, 2022
Nov 16, 2022
Nov 15, 2022

Repository files navigation

Thorium Reader

Thorium Reader is an easy to use EPUB reading application for Windows 10/10S, MacOS and Linux. After importing e-books from a directory or OPDS feed, you'll be able to read on any screen size, customize layout settings, navigate via the table of contents or page list, set bookmarks ... A great care is taken to ensure the accessibility of the application for visual impaired people using NVDA, JAWS or Narrator.

Free application. No ads. No private data flowing anywhere.

This project is in constant evolution, corrections and new features will be added soon and your support is welcome for that. The application is based on the open-source Readium Desktop toolkit.

It is currently localized in following languages:

  • English
  • French
  • Portuguese
  • Swedish
  • Russian
  • Lithuanian
  • Italian
  • Japanese
  • Dutch
  • Spanish
  • German
  • Finnish
  • Chinese
  • Korean
  • Georgian
  • Basque
  • Galician
  • Catalan

See: https://github.com/edrlab/thorium-reader/wiki/Localization-(l10n)-language-translations

library publication info reader

Prerequisites

  1. NodeJS 16 (check with node --version)
  2. NPM 8 (check with npm --version)

Technologies

  • typescript
  • electron
  • reactjs
  • redux
  • saga
  • i18next

Quick start

Install dependencies

  • npm install (or npm ci): initialize local node_modules packages from dependencies declared in package.json (this will also automatically call a long-running compilation stage in npm run postinstall)
  • in case of failure to NPM "install" because of "Divina player" SHA integrity mismatch, please try running the following command in your shell: node scripts/package-lock-patch.js && cat package-lock.json | grep -i divina-player-js

Start application in development environment

(with hot-reload dev server, web inspectors / debuggers)

  • npm run start:dev (or npm run start:dev:quick to bypass TypeScript checks / launch the app faster)

Start application in production environment

  • npm start (or npm run start)

Build installers

  • npm run package:win or npm run package:mac or npm run package:linux

Code Signing information: https://github.com/edrlab/thorium-reader/wiki/Code-Signing

Command line

thorium <cmd> [args]

Commands:
  thorium opds <title> <url>  import opds feed
  thorium import <path>       import epub or lpcl file
  thorium read <title>        searches already-imported publications with the
                              provided TITLE, and opens the reader with the
                              first match
  thorium [path]              import and read an epub or lcpl file     [default]
  thorium completion          generate bash completion script

Positionals:
  path  path of your publication, it can be an absolute, relative path  [string]

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

About

A cross platform desktop reading app, based on the Readium Desktop toolkit

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 62.5%
  • JavaScript 27.0%
  • HTML 6.0%
  • CSS 4.5%