Electron-builder Mac Target Zip Dmg

electron-builder

  • To distribute your app with Electron, you need to package it for each operating system you want to target. The goal is to generate a.exe file for Windows, a.app for macOS, and a.deb for Debian-based Linux distributions.
  • Version: 21.2.0 Electron updater: 4.1.2 Target: mac & win Electron 6.0.12 & Node 12.4.0 Trying to build for win and mac (on a mac with Catalina) manages to build some of the files but the fails here:% electron-builder build -mac -win.

At the time of writing Electron Builder still contains a bug that causes the your-app-mac.zip file to have an unsigned copy of your application (the your-app.dmg will work just fine). Due to a bug in Electron Builder the zipped version of your app wil not open.

A complete solution to package and build a ready for distribution Electron, Proton Native or Muon app for macOS, Windows and Linux with “auto update” support out of the box.

See documentation on electron.build.

  • NPM packages management:
    • Native application dependencies compilation (including Yarn support).
    • Development dependencies are never included. You don't need to ignore them explicitly.
    • Two package.json structure is supported, but you are not forced to use it even if you have native production dependencies.
  • Code Signing on a CI server or development machine.
  • Auto Update ready application packaging.
  • Numerous target formats:
    • All platforms: 7z, zip, tar.xz, tar.7z, tar.lz, tar.gz, tar.bz2, dir (unpacked directory).
    • macOS: dmg, pkg, mas.
    • Linux: AppImage, snap, debian package (deb), rpm, freebsd, pacman, p5p, apk.
    • Windows: nsis (Installer), nsis-web (Web installer), portable (portable app without installation), AppX (Windows Store), MSI, Squirrel.Windows.
  • Publishing artifacts to GitHub Releases, Amazon S3, DigitalOcean Spaces and Bintray.
  • Advanced building:
    • Pack in a distributable format already packaged app.
    • Separate build steps.
    • Build and publish in parallel, using hard links on CI server to reduce IO and disk space usage.
  • electron-compile support (compile for release-time on the fly on build).
  • Docker images to build Electron app for Linux or Windows on any platform.
  • Proton Native and Muon support.
QuestionAnswer
“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.

Electron-builder Mac Target Zip Dmg File

Installation

Yarn is strongly recommended instead of npm.

yarn add electron-builder --dev

Electron-builder mac target zip dmg

Quick Setup Guide

Electron-builder Mac Target Zip Dmg Free

electron-webpack-quick-start is a recommended way to create a new Electron application. See Boilerplates.

  1. Specify the standard fields in the application package.json — name, description, version and author.

  2. Specify the build configuration in the package.json as follows:

    See all options.

  3. Add icons.

  4. Add the scripts key to the development package.json:

    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.

  5. 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.

Donate

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.

Electron-builder Mac Target Zip Dmg File Size

Sponsors