Brief of the project

Work in progress

Setup

git clone git@github.com:pietrop/interactive-audio-ebook.git

cd interactive-audio-ebook

npm install

Usage

TBC

System Architecture

Working diagram here

TBC

Documentation

There's a docs folder in this repository.

docs/notes contains dev draft notes on various aspects of the project. This would generally be converted either into ADRs or guides when ready.

docs/adr contains Architecture Decision Record.

An architectural decision record (ADR) is a document that captures an important architectural decision made along with its context and consequences.

We are using this template for ADR

Development env

• npm > 6.1.0
• Node 10 - dubnium

Node version is set in node version manager .nvmrc

worker_threads became available in Node.js 10.5.0. Prior to Node.js 11.7.0, you could not access the module unless you started node with the --experimental-worker flag.

from https://medium.com/@Trott/using-worker-threads-in-node-js-80494136dbb6

Build

TBC

Tests

TBC

Deployment

To github pages at http://pietropassarelli.com/interactive-audio-ebook/huckfinn_01_twain_apc_64kb.html

npm run deploy:ghpages