Skip to content

Developer quick start

Maxwell Simmer edited this page May 8, 2019 · 5 revisions

Developer quick start

Development (general)

Watch for changes in all packages from the repository's root by running:

$ npm run watch

The npm run watch command can also be used in any of the package directories.

Development (Reader)

The Reader is a React app built with webpack. For development, an Express server can be started to preview projects in a Git ignored epub directory in packages/b-ber-reader.

./b-ber-reader
├── epub
│   ├── test-epub
│   │   ├── META-INF
│   │   │   └── container.xml
│   │   ├── OPS
│   │   │   ├── content.opf
│   │   │   ├── fonts
│   │   │   ├── images
│   │   │   ├── javascripts
│   │   │   ├── media
│   │   │   ├── stylesheets
│   │   │   ├── text

To test out projects with the Reader, add EPUBs to the packages/b-ber-reader/epub directory, start the server, and launch the Reader:

$ cd packages/b-ber-reader
$ npm start

The Express server will serve the contents of the epub directory.

Testing

From the project root or from any individual package directory run:

$ npm test
Clone this wiki locally