Installation - Web

Installing Colibrio Reader Framework

The Colibrio Reader Framework is written in TypeScript and compiled to ES5 compatible Javascript. The code is organized into a set of UMD modules, which should be compatible with most module loaders.

While using Typescript is optional, we highly recommend that you write your app in TypeScript with "strict" type checking enabled to get full typing support for the framework.

We recommend that you use a module loader/bundler such as Webpack or to build your app. We recommend that you use ES2015 imports to load modules if possible.

Installing TypeScript framework with Yarn or NPM

First, you need to add our NPM Registry to your project so you can fetch packages prefixed with @colibrio/.

Inside the root of your project, open the file .npmrc (or create it if it does not exist). Add the following lines:

CODE

@colibrio:registry=https://npm.pkg.colibrio.com/
//npm.pkg.colibrio.com/:_authToken=<YOUR_AUTH_TOKEN>
//npm.pkg.colibrio.com/:always-auth=true

where <YOUR_AUTH_TOKEN> should be replaced with the NPM auth token you have received from Colibrio.

You can now install Colibrio Reader Framework with Yarn:

CODE

yarn add @colibrio/colibrio-reader-framework --dev

or with NPM:

CODE

npm install @colibrio/colibrio-reader-framework --save-dev

You can now start using the framework in your code:

TYPESCRIPT

import {ReadingSystemEngine} from '@colibrio/colibrio-reader-framework/colibrio-readingsystem-engine'

// Do something with ReadingSystemEngine

Tutorials

To get up and running with implementing an app with Colibrio Reader Framework, we suggest to check out the Web framework tutorials.