Note This template has several branches with different features (see Branches for details).
This is a boilerplate or template -- i.e. it is placeholder sample source code, and development tooling -- for an Electron application.
To use this template to start your own application:
-
Read the "Hello world" source code in the
./src/*/folders -
Replace that, by writing your own source code for these folders
-
Use the scripts, which are defined in
package.jsonand described here:How to use the command line interface (CLI) for Electron Forge
-
Edit the descriptive fields in
package.json(i.e. including thename,author,license, and so on). -
Add an icon as described here:
This boilerplate supports:
- Electron
- Written using TypeScript, and using React in the renderer
- IPC in both directions, between the main process and the renderer, implemented using a preload script
The boilerplate includes "Hello world" source files to show how the IPC and React are implemented and used at run-time.
The toolchain defined by Electron Forge supports:
- Hot reloading or quick restart at development time
- Packaging for deployment
It seems to be based on Webpack and the TypeScript compiler and not on Babel.
How this was implemented describes how I created this template step-by-step.
For details see also the user guides for these components: