Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alice-em/wonder-reader
Comic Book Reader, written with Node and based on Electron
https://github.com/alice-em/wonder-reader
comic comics-reader desktop-app electron javascript nodejs reader
Last synced: 3 days ago
JSON representation
Comic Book Reader, written with Node and based on Electron
- Host: GitHub
- URL: https://github.com/alice-em/wonder-reader
- Owner: alice-em
- License: mit
- Created: 2016-03-15T17:09:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:27:35.000Z (about 2 years ago)
- Last Synced: 2024-04-13T21:57:53.954Z (10 months ago)
- Topics: comic, comics-reader, desktop-app, electron, javascript, nodejs, reader
- Language: JavaScript
- Homepage:
- Size: 365 MB
- Stars: 56
- Watchers: 5
- Forks: 10
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://david-dm.org/alice-em/wonder-reader?type=dev)
## 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
* [.exe](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/Wonder%20Reader%20Setup%201.0.1.exe)
###### OSX / Darwin
* [.dmg](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/Wonder%20Reader-1.0.1.dmg)
* [.zip](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/Wonder%20Reader-1.0.1-mac.zip)
###### Linux
* [.AppImage](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/wonder-reader-1.0.1-x86_64.AppImage)
* [.deb](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/wonder-reader_1.0.1_amd64.deb)
* [.rpm](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/wonder-reader-1.0.1.x86_64.rpm)
* [.snap](http://sevenouncestudios.com/wonder-reader/bin/1.0.1/wonder-reader_1.0.1_amd64.snap)
* `snap install wonder-reader`
## 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](https://github.com/chentsulin/electron-react-boilerplate/issues/400)**
First, clone the repo via git:
```bash
git clone https://github.com/alice-em/wonder-reader.git
```
And then install dependencies with yarn.
```bash
$ cd wonder-reader
$ yarn
```
**Note**: If you can't use [yarn](https://github.com/yarnpkg/yarn), run `npm install`.
## Run
Start the app in the `dev` environment. This starts the renderer process in [**hot-module-replacement**](https://webpack.js.org/guides/hmr-react/) mode and starts a webpack dev server that sends hot updates to the renderer process:
```bash
$ 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:
```bash
$ npm run start-renderer-dev
$ npm run start-main-dev
```
## Packaging
To package apps for the local platform:
```bash
$ npm run package
```
To package apps for all platforms:
First, refer to [Multi Platform Build](https://www.electron.build/multi-platform-build) for dependencies.
Then,
```bash
$ npm run package-all
```
To package apps with options:
```bash
$ npm run package -- --[option]
```
To run End-to-End Test
```bash
$ npm run build
$ npm run test-e2e
```
To run Unit Test
```bash
$ cd app
$ npm rebuild @fknop/node-unrar --update-binary
$ cd ..
$ npm run test
```
:bulb: You can debug your production build with devtools by simply setting the `DEBUG_PROD` env variable:
```bash
DEBUG_PROD=true npm run package
```