Electron-based viewer for galactic-history-generator output
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
test
.babelrc
.editorconfig
.eslintrc
.gitattributes
.gitignore
.travis.yml
LICENSE
README.md
erb-logo.png
main.js
package.js
package.json
server.js
webpack.config.base.js
webpack.config.development.js
webpack.config.node.js
webpack.config.production.js

README.md

galactic-history-viewer

Build Status

Human-friendly viewer for json files generated by galactic-history-viewer. Electron application based on React and Webpack.

Install

First, clone the repo via git:

git clone https://github.com/chentsulin/electron-react-boilerplate.git your-project-name

And then install dependencies.

$ cd your-project-name && npm install

Run

Run these two commands simultaneously in different console tabs.

$ npm run hot-server
$ npm run start-hot

or run two servers with one command

$ npm run dev

Note: requires a node version >= 4 and an npm version >= 2.

DevTools

Toggle Chrome DevTools

  • OS X: Cmd Alt I or F12
  • Linux: Ctrl Shift I or F12
  • Windows: Ctrl Shift I or F12

See electron-debug for more information.

Toggle Redux DevTools

  • All platforms: Ctrl+H

See redux-devtools-dock-monitor for more information.

Redux Devtools Window

Now you can implement it using remote-redux-devtools with a remote monitor by yourself.

Package

$ npm run package

To package apps for all platforms:

$ npm run package-all

Options

  • --name, -n: Application name (default: ElectronReact)
  • --version, -v: Electron version (default: latest version)
  • --asar, -a: asar support (default: false)
  • --icon, -i: Application icon
  • --all: pack for all platforms

Use electron-packager to pack your app with --all options for darwin (osx), linux and win32 (windows) platform. After build, you will find them in release folder. Otherwise, you will only find one for your os.

test, tools, release folder and devDependencies in package.json will be ignored by default.

Building windows apps from non-windows platforms

Please checkout Building windows apps from non-windows platforms.

How hot-reloading works on Elecrton

We use webpack-target-electron-renderer to provide a build target for electron renderer process. Read more information here.