A complete solution to package and build a ready for distribution Electron, Proton Native app for macOS, Windows and Linux with “auto update” support out of the box.
See documentation on electron.build.
7z
, zip
, tar.xz
, tar.7z
, tar.lz
, tar.gz
, tar.bz2
, dir
(unpacked directory).dmg
, pkg
, mas
.deb
), rpm
, freebsd
, pacman
, p5p
, apk
.nsis
(Installer), nsis-web
(Web installer), portable
(portable app without installation), AppX (Windows Store), MSI, Squirrel.Windows.Question | Answer |
---|---|
“I want to configure electron-builder” | See options |
“I have a question” | Open an issue or join the chat |
“I found a bug” | Open an issue |
“I want to support development” | Donate |
Real project example — onshape-desktop-shell.
Yarn is strongly recommended instead of npm.
yarn add electron-builder --dev
electron-webpack-quick-start is a recommended way to create a new Electron application. See Boilerplates.
Specify the standard fields in the application package.json
— name, description
, version
and author.
Specify the build configuration in the package.json
as follows:
"build": {
"appId": "your.id",
"mac": {
"category": "your.app.category.type"
}
}
See all options. Option files to indicate which files should be packed in the final application, including the entry file, maybe required.
Add icons.
Add the scripts key to the development package.json
:
"scripts": {
"pack": "electron-builder --dir",
"dist": "electron-builder"
}
Then you can run yarn dist
(to package in a distributable format (e.g. dmg, windows installer, deb package)) or yarn pack
(only generates the package directory without really packaging it. This is useful for testing purposes).
To ensure your native dependencies are always matched electron version, simply add script "postinstall": "electron-builder install-app-deps"
to your package.json
.
If you have native addons of your own that are part of the application (not as a dependency), set nodeGypRebuild to true
.
Please note that everything is packaged into an asar archive by default.
For an app that will be shipped to production, you should sign your application. See Where to buy code signing certificates.
We do this open source work in our free time. If you'd like us to invest more time on it, please donate. Donation can be used to increase some issue priority.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。