README.md

Hearmenow Electron App

Download app

Get the Electron App

Download

Built With

Electron application based on React, Redux, React Router, Webpack, React Transform HMR for rapid application development

Install

• Note: requires a node version >= 6 and an npm version >= 3.

First, clone the repo via git:

git clone https://github.com/leesander1/hearmenow-electron.git

And then install dependencies. ProTip: Install with yarn for faster and safer installation

$ cd hearmenow-electron && 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

Editor Configuration

Atom (optional)

apm install editorconfig es6-javascript atom-ternjs javascript-snippets linter linter-eslint language-babel autocomplete-modules file-icons

DevTools

This boilerplate is included following DevTools extensions:

• Devtron - Install via electron-debug.
• React Developer Tools - Install via electron-devtools-installer.
• Redux DevTools - Install via electron-devtools-installer.

You can find the tabs on Chrome DevTools.

If you want to update extensions version, please set UPGRADE_EXTENSIONS env, just run:

$ UPGRADE_EXTENSIONS=1 npm run dev

# For Windows
$ set UPGRADE_EXTENSIONS=1 && npm run 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]

Further commands

To run the application without packaging run

$ npm run build
$ npm start

To run End-to-End Test

$ npm run build
$ npm run test-e2e

Options

See electron-builder CLI Usage

Module Structure

This boilerplate uses a two package.json structure.

1. If the module is native to a platform or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under dependencies in ./app/package.json.
2. If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule.
3. Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

Authors

• Mario Jimenez - Initial work - mariots - mariotj.com
• Lee Sander - Initial work - leesander1 - leesander.com
• Kevin Taing - Initial work - kevintaing86

See also the list of contributors who participated in this project.

License

MIT

Acknowledgements

• Hat tip to anyone whose code was used
• template for README
• The labels used in the issues section were inspired by this site
• Issue and PR Templates were inspired by this site
• Dial pad template was from this site