Differences between revisions 1 and 8 (spanning 7 versions)
Revision 1 as of 2020-07-07 18:30:55
Size: 1975
Comment:
Revision 8 as of 2023-01-08 20:41:12
Size: 2522
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
## page was renamed from NodeJS/ElectronBuilder
Line 2: Line 3:

'''Electron Builder''' is a tool chain project to automate and simplify the build process for [[Node/Electron|Electron]] applications.
Line 9: Line 12:
== Build Process == == Installation ==

Upstream strongly recommends using '''`yarn(1)`''' (not `npm(1)`) to install '''Electron Builder'''.

{{{
yarn add electron-builder --dev
}}}

----



== Usage ==

Line 18: Line 35:
"description": "This is My App.",
Line 27: Line 45:
"scripts": {
  "pack": "electron-builder --dir",
  "dist": "electron-builder"
}
Line 30: Line 52:

The scripts enable use as `yarn pack` and `yarn dist`.
Line 53: Line 77:

Electron Builder

Electron Builder is a tool chain project to automate and simplify the build process for Electron applications.


Installation

Upstream strongly recommends using yarn(1) (not npm(1)) to install Electron Builder.

yarn add electron-builder --dev


Usage

Targets

A 'minimal' package.json file is as:

"name": "my-app",
"productName": "My App",
"description": "This is My App.",
"author": {
  "name": "Me",
  "email": "[email protected]"
},
"version": "0.0.1",
"license": "GPL-3.0",
"build": {
  appId: "com.example.app",
},
"scripts": {
  "pack": "electron-builder --dir",
  "dist": "electron-builder"
}

Note that appId feeds directly into the build process for macOS and Windows (NSIS target only).

The scripts enable use as yarn pack and yarn dist.

Under build, there are target-specific objects.

Keyword

Description

mac

options for all macOS targets

mas

Mac Application Store options

dmg

macOS DMG options

pkg

macOS PKG options

win

options for all Windows targets

nsis

NSIS options

nsisWeb

web installer options inheriting from NSIS options

appx

Windows App Store (AppX) options

squirrelWindows

Squirrel Windows options

linux

options for all Linux targets

deb

Debian options

snap

SnapCraft options

appImage

AppImage options

pacman

pacman options

rpm

RPM options

freebsd

FreeBSD options

p5p

Solaris options

apk

Alpine Linux options


CategoryRicottone

Node/ElectronBuilder (last edited 2023-01-08 20:43:25 by DominicRicottone)