{"id":27996689,"url":"https://github.com/edrlab/thorium-web","last_synced_at":"2026-03-11T13:27:49.306Z","repository":{"id":245697764,"uuid":"817656901","full_name":"edrlab/thorium-web","owner":"edrlab","description":"🌐 An open-source ebook/audiobook/comics Web Reader","archived":false,"fork":false,"pushed_at":"2026-02-05T18:53:14.000Z","size":6307,"stargazers_count":71,"open_issues_count":55,"forks_count":21,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2026-02-06T11:34:07.656Z","etag":null,"topics":["audiobooks","epub","readium","web"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edrlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-06-20T07:24:53.000Z","updated_at":"2026-01-29T23:06:43.000Z","dependencies_parsed_at":"2024-06-23T14:43:23.009Z","dependency_job_id":"dbda243f-1873-4656-946e-c3b8d679a2f2","html_url":"https://github.com/edrlab/thorium-web","commit_stats":null,"previous_names":["readium/playground","edrlab/thorium-web"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/edrlab/thorium-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edrlab%2Fthorium-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edrlab%2Fthorium-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edrlab%2Fthorium-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edrlab%2Fthorium-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edrlab","download_url":"https://codeload.github.com/edrlab/thorium-web/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edrlab%2Fthorium-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29298522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-10T10:40:02.018Z","status":"ssl_error","status_checked_at":"2026-02-10T10:38:28.459Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audiobooks","epub","readium","web"],"created_at":"2025-05-08T21:48:52.033Z","updated_at":"2026-02-10T12:00:50.898Z","avatar_url":"https://github.com/edrlab.png","language":"TypeScript","readme":"# Thorium Web\n\nThorium Web is a web-based reader for EPUB and other digital publications, built using Next.js and modern web technologies. It is designed to provide a fast, responsive, and accessible reading experience.\n\n![Thorium Web in a browser with settings and table of contents panels open. Default settings such as font-size, font-family, and themes are visible in the overflowing settings panel. In table of contents, the current entry is indicated, and its parent entry is expanded.](./thorium-web.png)\n\n## Features\n\n- Supports EPUB\n- Fast and responsive rendering of publications using Next.js\n- Accessible design for readers with disabilities\n- Customizable reading experience with themes, adjustable font sizes, line heights, word- and letter-spacing, etc.\n\n## Getting Started\n\nThere are two ways to get started with Thorium Web:\n\n- Using the Next.JS App as is\n- Using the Thorium Web package in your own project\n\nYou can take a look at the [Implementers’ Guide](./docs/ImplementersGuide.md) for more details.\n\n### Using the Next.JS App as is\n\nTo get started with Thorium Web, follow these steps:\n\n- Fork or clone the repository: `git clone https://github.com/edrlab/thorium-web.git`\n- Install dependencies: `pnpm install`\n- Start the development server: `pnpm dev`\n- Open the reader in your web browser: [http://localhost:3000](http://localhost:3000)\n\nThe development server will automatically reload the page when you make changes to the code.\n\n### Using the Thorium Web package in your own project\n\nTo use Thorium Web in your own project, install the package and its peer dependencies:\n\n```bash\nnpm install @edrlab/thorium-web @readium/css @readium/navigator @readium/navigator-html-injectables @readium/shared react-redux @reduxjs/toolkit i18next i18next-browser-languagedetector i18next-http-backend motion react-aria react-aria-components react-stately react-modal-sheet react-resizable-panels \n```\n\nThen you can import and use the components in your own code:\n\n```tsx\nimport { StatefulReader } from \"@edrlab/thorium-web/epub\"\n\nconst MyApp = () =\u003e {\n  // ... fetch the manifest and get its self link href\n  return (\n    \u003cStatefulReader\n      rawManifest={ manifestObject }\n      selfHref={ manifestSelfHref }\n    /\u003e\n  )\n}\n```\n\nYou can use the StatefulReader component to use the same exact Reader component as the one in the Next.JS App, but with your own [plugins, store and preferences](./docs/packages/Epub/Guide.md). Or you can use its components to build your own custom reader.\n\n\u003e [!IMPORTANT]\n\u003e At this point in time, when using components from `@edrlab/thorium-web/epub`, you have to import the store/lib, hooks and Preferences Provider from the same path, otherwise your custom app will use another instance.\n\n## Customizing\n\nYou can customize this project extensively through [Preferences](./src/preferences.ts): breakpoints, which and how to display actions, themes provided to users, configuration of the docking system, sizes and offsets of icons, etc.\n\nSee [Customization in docs](./docs/customization/Customization.md) for further details.\n\n## Building and Deploying\n\nTo build and deploy Thorium Web, run the following commands:\n\n```bash\npnpm build\npnpm run deploy\n```\n\nThis will create a production-ready build of the reader and deploy it to the specified hosting platform.\n\nThis repository is using the following configuration:\n\n- Go-Toolkit on Google Cloud Run\n- Thorium Web App on CloudFlare Pages\n- Assets e.g. demo EPUBs stored on Google Cloud Storage\n\nTo deploy, the following script is run: \n\n```bash\nnpx @cloudflare/next-on-pages \u0026\u0026 npx wrangler pages deploy\n```\n\nIt’s running with defaults, which means a commit triggers a build and deploy for the current branch to preview. You can then access the app from a subdomain using this branch name. \n\nMore details in [the @cloudflare/next-on-pages repo](https://github.com/cloudflare/next-on-pages).\n\n## Known Issues\n\n- Fullscreen is not available on iOS and very limited on iPadOS. We encountered so many issues on iPadOS that it has been disabled for the time being.\n- on iPadOS, when the app is requested in its desktop version, some interventions are implemented in Safari to provide users with a “desktop-class experience.” Unfortunately, one of this intervention is impacting the font-size setting, and requires a flag to be toggled in the Preferences API in order to apply a patch. However, this patch may not catch all edge cases.\n\n## Contributing\n\nWe welcome contributions to Thorium web! If you're interested in helping out, please fork this repository and submit a pull request with your changes.\n\nThe only exception to this rule is localization files, which are managed through a separate process. Please see the [Localization](./docs/Localization.md) documentation for more details.\n\n## License\n\nThorium Web is licensed under the [BSD-3-Clause license](https://opensource.org/licenses/BSD-3-Clause).\n\n## Acknowledgments\n\nThorium Web is built using a number of open-source libraries and frameworks, including [Readium](https://readium.org/), [React](https://reactjs.org/), [React Aria](https://react-spectrum.adobe.com/react-aria/index.html), and [Material Symbols and Icons](https://fonts.google.com/icons). We are grateful for the contributions of the developers and maintainers of these projects.","funding_links":[],"categories":["Open-source applications"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedrlab%2Fthorium-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedrlab%2Fthorium-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedrlab%2Fthorium-web/lists"}