Uses a minimal webpack config to bundle everything together, and includes just what you need to build your electron app. Tiny enough so that you keep a good overview of everything, simple enough for you to add what you need and still complete enough to start working on production projects.
redux. They are dead-simple to integrate manually, this boilerplate does not make assumptions about your tech stack.
electron-builderincluded for bundling the app for Windows, Linux and Mac. Easily adjustable configurations allows bundling installers or zipped portable packages.
prettierincluded for formatting.
The CI pipeline is setup to automatically release new versions for
pushed tags. Make sure to bump the version in the
file, and tag the commit with the new version (e.g.
The following manual steps have to be completed initially to setup releases:
GH_SECRETthat has repo access
resources/icon.pngwith a suitable logo image. Note that, for the Mac OS build to work, it must be at least 512x512
prettier are included for
convenience, but can easily be removed if you don't want them.
js/main.js(render logic) are placed in the
app/folder, which is loaded into the root of the
resources/app.asararchive once built into an distributable package.
webpack-renderer.config.tsif you want to load those files in the render process, or in
webpack-electron.config.tsfor the main process.
npm runin the scripts inside of
fs-method do not return and block indefinitely.
app.allowRendererProcessReuse = false;in