In this electron packager tutorial we will look at how to create MacOS, Windows and Linux executables with an app icon. This is also a continuation of the Electron app icon post, so start there if you haven’t read it (It’s short, i promise).
I add this code to the Electron tutorial app on github. Just look at that repo if you want to see all the code.
1. Install Electron packager
Electron packager is created by electron-userland and this is what they say about it:
“Electron Packager is a command line tool and Node.js library that bundles Electron-based application source code with a renamed Electron executable and supporting files into folders ready for distribution.”
So lets go ahead and install it. Run these commands in the terminal in the app folder:
2. Setting productname and electron version
Electron packager looks for a product name in package.json, so lets go ahead and add one. We also need to add what version of electron to package the app with.
Lets begin with the electron version. We’ll add that from the terminal with this command:
Now when that is done open up package.json and add a productname:
3. Building MacOS, Windows and Linux package from the terminal
To get to know what all these flags do, and what more flags exists you can read the electron-packager api.
Now you can run this command from the terminal to build a package for mac:
And to build for Windows you can run this from the git bash:
overwrite: replaces any existing output directory when packaging.
platform: The target platform to build for
arch: the architecture to build for
icon: sets the icon for the app
prune: runs npm prune –production before packaging the app. It removes unnecesary packages.
out: the name of the directory where the packages are created.
To make it easier to create new builds we can create scripts in package.json so that we don’t have to remember all these settings. Add the scripts below, making your package.json look like this:
Now you can run:
The next tutorial in this series is Electron menu. It explains how to add a menu to your app.