katallaxie / electron-react-preboot

:electric_plug: A teeny tiny boilerplate for TypeScript :sunglasses: + Electron + React.

electron-react-preboot

A Highly Opinionated Boilerplate For Electron + React

Install

requires a node version >= 6 and an npm version >= 3.x.x

First, clone the repo via git:

git clone --depth=1 https://github.com/katallaxie/electron-react-preboot.git your-awesome-project

And then install dependencies with npm.

$ cd your-awesome-project
$ npm i

you will find readly compiled files in app

Run

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

$ npm run start

that's it, you have your awesome Electron up an running

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.

DevTools extension

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.

Packaging

To package apps for the local platform:

$ npm run publish

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

License

MIT © Sebastian Döll