Wonder Reader

A digital comic book reader

devDependencies Status

Wonder Reader :: A modern comic book reader for Windows, OSX, and Linux

Wonder Reader was written with React, Electron, Node, and a love for all things dorky.

Downloads version 1.0.1

Windows
OSX / Darwin
Linux

Requirements for development

git, npm, node, yarn, & bash

Install

  • Note: requires a node version >= 7 and an npm version >= 4.
  • If you have installation or compilation issues with this project, please see the debugging guide

First, clone the repo via git:

git clone https://github.com/alice-em/wonder-reader.git

And then install dependencies with yarn.

$ cd wonder-reader
$ yarn

Note: If you can't use yarn, run npm install.

Run

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a webpack dev server that sends hot updates to the renderer process:

$ npm run dev

Alternatively, you can run the renderer and main processes separately. This way, you can restart one process without waiting for the other. Run these two commands simultaneously in different console tabs:

$ npm run start-renderer-dev
$ npm run start-main-dev

Packaging

To package apps for the local platform:

$ npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ npm run package-all

To package apps with options:

$ npm run package -- --[option]

To run End-to-End Test

$ npm run build
$ npm run test-e2e

💡 You can debug your production build with devtools by simply setting the DEBUG_PROD env variable:

DEBUG_PROD=true npm run package
not_used

Something missing? Edit this app.