Skip to content

Developer quick start

Maxwell Simmer edited this page Oct 23, 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 managed with webpack. For development, an Express server can be started to preview projects in a .gitignored 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
$ yarn start

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

Testing

Tests are run with Jest. Run test suites from the project root or from any individual package directory by running:

$ npm test
Clone this wiki locally