To distribute your app with Electron, you need to package and rebrand it. To do this, you can either use specialized tooling or manual approaches.
There are a couple tools out there that exist to package and distribute your Electron app. We recommend using Electron Forge. You can check out its documentation directly, or refer to the Packaging and Distribution part of the Electron tutorial.
If you prefer the manual approach, there are 2 ways to distribute your application:
- With prebuilt binaries
- With an app source code archive
With prebuilt binaries
To distribute your app manually, you need to download Electron's prebuilt
binaries. Next, the folder
containing your app should be named
app and placed in Electron's resources
directory as shown in the following examples.
The location of Electron's prebuilt binaries is indicated
electron/ in the examples below.
Electron.app on macOS,
electron on Linux, or
on Windows, and Electron will start as your app. The
will then be your distribution to deliver to users.
With an app source code archive (asar)
Instead of shipping your app by copying all of its source files, you can package your app into an asar archive to improve the performance of reading files on platforms like Windows, if you are not already using a bundler such as Parcel or Webpack.
To use an
asar archive to replace the
app folder, you need to rename the
app.asar, and put it under Electron's resources directory like
below, and Electron will then try to read the archive and start from it.
You can find more details on how to use
asar in the
Rebranding with downloaded binaries
After bundling your app into Electron, you will want to rebrand Electron before distributing it to users.
Windows: You can rename
electron.exeto any name you like, and edit its icon and other information with tools like rcedit.
Linux: You can rename the
electronexecutable to any name you like.
macOS: You can rename
Electron.appto any name you want, and you also have to rename the
CFBundleNamefields in the following files:
You can also rename the helper app to avoid showing
Electron Helperin the Activity Monitor, but make sure you have renamed the helper app's executable file's name.
The structure of a renamed app would be like:
│ └── MyApp
└── MyApp Helper.app
└── MyApp Helper
it is also possible to rebrand Electron by changing the product name and
building it from source. To do this you need to set the build argument
corresponding to the product name (
electron_product_name = "YourProductName")
args.gn file and rebuild.
Keep in mind this is not recommended as setting up the environment to compile from source is not trivial and takes significant time.