electron-runner

#electron-runner

Simple wrapper around electron package. Built on electron-quick-start boilerplate, but it hides boilerplate code. It's meant to enable run JavaScript code in Electron without writing any electron specific code. You can run for example NodeJS application for purpose of debugging (using chrome dev tools, for example).

Note: this package is running code in renderer Electron process so if you need to access main process you should rather use other Electron boilerplate.

It allows you to specify simple configuration file, for example:

module.exports = {
     // arbitrary html file which will be your entry point.
     // You should include/require your JavaScript files from this file by using `script` tags or `require` function.
     // you can also use ---generate option for autogenerating *.html file which will include your NodeJS script.
    url:  'file://' + require('path').join(__dirname, 'hello.html'),

    menu: [/*data for menu items in format understood by Electron */], // optional

    openDevTools: true // optional

};

usage:

npm install --save-dev electron-runner
node_modules/.bin/electron-runner PATH_FOR_CONFIG_FILE

generate HTML containers (it will output html code into standard output)

node_modules/.bin/electron-runner --generate PATH_FOR_JAVASCRIPT_FILE

for example

1. node_modules/.bin/electron-runner --generate index.js > index.html
2. ( edit url property in your config file to point at index.html)
3. node_modules/.bin/electron-runner YOUR_CONFIG.js