Name: electron-builder
Owner: Brave Software
Description: Complete solution to package and deploy Electron apps
Forked from: electron-userland/electron-builder
Created: 2016-07-28 21:19:49.0
Updated: 2017-04-30 00:42:58.0
Pushed: 2017-04-24 22:31:18.0
Size: 105810
Language: TypeScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Complete solution to package and build ready for distribution and “auto update” Electron app for MacOS, Windows and Linux.
7z
, zip
, tar.xz
, tar.lz
, tar.gz
, tar.bz2
.dmg
, mas
.AppImage
, deb
, rpm
, freebsd
, pacman
, p5p
, apk
.appdmg are used under the hood.
Note: appdmg
(and the platform specific 7zip-bin-*
packages) are optionalDependencies
, which may require manual install if you have npm configured to not install optional deps by default.
Real project example ? onshape-desktop-shell.
We recommend to use two package.json files (it is not required, you can build project with any structure).
For development
In the root of the project. Here you declare dependencies for your development environment and build scripts.
For your application
In the app
directory. Only this directory is distributed with real application.
Why?
devDependencies
need to be compiled against your locally installed node.js. Thanks to having two files this is trivial (see #39).app
directory).Please see Loading App Dependencies Manually and #379.
See options, but consider to follow simple guide outlined below at first.
For a production app you need to sign your application, see Where to buy code signing certificate.
Specify standard fields in the application package.json
? name, description
, version
and author (for Linux homepage and license are also required).
Specify build field in the development package.json
:
ld": {
ppId": "your.id",
pp-category-type": "your.app.category.type",
in": {
"iconUrl": "(windows-only) https link to icon"
See options. This object will be used as a source of electron-packager options. You can specify any other options here.
Create directory build
in the root of the project and put your background.png
(MacOS DMG background), icon.icns
(MacOS app icon) and icon.ico
(Windows app icon).
icns
file (or you can put them into the build/icons
directory ? filename must contains size (e.g. 32x32.png
)).
Add scripts to the development package.json
:
ipts": {
ostinstall": "install-app-deps",
ack": "build --dir",
ist": "build"
And then you can run npm run dist
(to package in a distributable format (e.g. dmg, windows installer, deb package)) or npm run pack
(useful to test).
Install required system packages.
Please note ? packaged into an asar archive by default.
electron-builder
produces all required artifacts:
.dmg
: MacOS installer, required for MacOS user to initial install.-mac.zip
: required for Squirrel.Mac..exe
and -ia32.exe
: Windows installer, required for Windows user to initial install. Please note ? your app must handle Squirrel.Windows events. See real example..full-nupkg
: required for Squirrel.Windows.For auto updating to work, you must implement and configure Electron's autoUpdater
module (example).
You also need to deploy your releases to a server.
Consider using Nuts (GitHub as a backend to store assets), Electron Release Server or Squirrel Updates Server.
See the Publishing Artifacts section of the Wiki for information on configuring your CI environment for automatic deployment.
For windows consider only distributing 64-bit versions.
Execute node_modules/.bin/build --help
to get actual CLI usage guide.
ding:
mac, -m, -o, --osx Build for MacOS, accepts target list (see
https://goo.gl/HAnnq8). [array]
linux, -l Build for Linux, accepts target list (see
https://goo.gl/O80IL2) [array]
win, -w, --windows Build for Windows, accepts target list (see
https://goo.gl/dL4i8i) [array]
x64 Build for x64 [boolean]
ia32 Build for ia32 [boolean]
dir Build unpacked dir. Useful to test. [boolean]
ishing:
publish, -p Publish artifacts (to GitHub Releases), see
https://goo.gl/WMlr4n
[choices: "onTag", "onTagOrDraft", "always", "never"]
draft Create a draft (unpublished) release [boolean]
prerelease Identify the release as a prerelease [boolean]
ecated:
platform The target platform (preferred to use --mac, --win or --linux)
[choices: "mac", "osx", "win", "linux", "darwin", "win32", "all"]
arch The target arch (preferred to use --x64 or --ia32)
[choices: "ia32", "x64", "all"]
r:
help Show help [boolean]
version Show version number [boolean]
ples:
ild -mwl build for MacOS, Windows and Linux
ild --linux deb tar.xz build deb and tar.xz for Linux
ild --win --ia32 build for Windows ia32
See node_modules/electron-builder/out/electron-builder.d.ts
. Typings is supported.
strict"
t builder = require("electron-builder")
t Platform = builder.Platform
romise is returned
der.build({
rgets: Platform.MAC.createTarget(),
vMetadata: {
"//": "build and other properties, see https://goo.gl/5jVxoO"
hen(() => {
// handle result
atch((error) => {
// handle error
See the Wiki for more documentation.