https://github.com/readium/ts-toolkit

A toolkit for ebooks, audiobooks and comics written in Typescript
https://github.com/readium/ts-toolkit

audiobooks cbr cbz ebook ebook-reader ebooks epub reading typescript webapp

Last synced: about 10 hours ago
JSON representation

A toolkit for ebooks, audiobooks and comics written in Typescript

• Host: GitHub
• URL: https://github.com/readium/ts-toolkit
• Owner: readium
• License: bsd-3-clause
• Created: 2019-11-06T17:28:58.000Z (about 5 years ago)
• Default Branch: develop
• Last Pushed: 2025-01-10T20:17:33.000Z (11 days ago)
• Last Synced: 2025-01-13T23:07:30.079Z (7 days ago)
• Topics: audiobooks, cbr, cbz, ebook, ebook-reader, ebooks, epub, reading, typescript, webapp
• Language: TypeScript
• Homepage:
• Size: 779 KB
• Stars: 68
• Watchers: 16
• Forks: 12
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-readium - TS toolkit - side applications (Toolkits)

README

        
# Readium Web

Next generation SDK for publications in Web Apps

## Usage

Three packages are made available by this repository, which are published on NPM.

They are:

- [@readium/shared](https://www.npmjs.com/package/@readium/shared)

- [@readium/navigator-html-injectables](https://www.npmjs.com/package/@readium/navigator-html-injectables)

- [@readium/navigator](https://www.npmjs.com/package/@readium/navigator)

# Development

You need `pnpm` installed as this is a monorepo using workspaces.

To install pnpm using node:

```sh

npm install -g pnpm

```

Note there are [several other options](https://pnpm.io/installation) if needed.

To install all dependencies:

```sh

pnpm install

```

Then workspaces should be all set up and you can build them from their directory in the following order:

1. shared

2. navigator-html-injectables

3. navigator

## Workspaces

- [Shared](./shared/): shared models to be used across other Readium projects and implementations in Typescript.

- [Navigator](./navigator/): a navigator for web platforms based on the readium Navigator spec.

- [Navigator-html-injectables](./navigator-html-injectables/): provides access and control over a resource from a navigator on any modern browser or embedded browser frame.

- [Testapp/vanilla](./testapp/vanilla/): an example of how to use the ts-toolkit.