mlibrary / cozy-sun-bear

EPUB widgets and support based around and with code from epub.js

cozy sun bear

ePub widgets and support based around and with code from epub.js

Development

Initial Setup

• clone the repository
• You have node installed (maybe with nodenv)
• npm install
• npm run build

Some of the examples use the IDPF epub3-samples examples; these are expected to be checked out in same directory containing cozy-sun-bear:

# Start in your cozy-sun-bear directory...
$ cd ..
# ./cozy-sun-bear/books/epub3-samples links to ./epub3-samples so clone it...
$ git clone https://github.com/IDPF/epub3-samples.git
# ./cozy-sun-bear/books/epub3-local links to ./epub3-local so create it...
$ mkdir epub3-local
$ cd cozy-sun-bear

More about maintaining local EPUB3 examples in the wiki.

To run the examples

• ./tools/serve
• Point your browser to http://127.0.0.1:8080/cozy-sun-bear/examples
• When you make changes to /src, re-run npm run build to build your changes
• ...or you can run npm run watch to have npm watch for changes to the javascript

To run Sass compiler

If you make changes to the generic stylesheet for cozy-sun-bear, you'll want to edit scss/cozy.scss and either run a one time build of the stylesheet (builds to dist/cozy.css) or run a watcher that watches for changes to scss/cozy.scss and automatically re-builds the stylesheet.

To do a one time build of the stylesheet:

• npm run build-css

To watch for changes to the stylesheet and run a build on save:

• npm run watch-css

To run the tests

To do a one time run of the complete test suite:

• npm test

To watch for changes to the source and run the suite on save:

• npm run ? TBD/TODO

Wiki

For additional details and helpful hints read the wiki.