Info

1. Brewdock Berlin
2. Brew Doctor Winnipeg
3. Brew Docker
4. Brew Doctor Kombucha Portland

Don’t expect that you can build app for all platforms on one platform.

• If your app has native dependency, it can be compiled only on the target platform unless prebuild is not used.

  prebuild is a solution, but most node modules don’t provide prebuilt binaries.

• macOS Code Signing works only on macOS. Cannot be fixed.

Download google chrome for mac catalina. Free public Electron Build Service is used to build Electron app for Linux on Windows. On macOS/Linux you can build Electron app for Windows locally, except Appx for Windows Store (in the future (feel free to file issue) electron-build-service will support Appx target).

You can use build servers — e.g. Travis to build macOS/Linux apps and AppVeyor to build Windows app.

Docker pull microsoft/mssql-server-windows-developer If you are following along step by step, brew up some tea or coffee and sit back, because this might take a while to complete. Not only is it downloading that image, but it is also downloading all the dependencies as well. Note: the Docker image cannot be used to perform a build directly, but you can use it to generate a build context which can be used with a container builder such as Docker, buildkit or Kaniko in another part of your build pipeline. Use-cases for the Docker image: Generate the build context without running docker build - faas-cli -shrinkwrap.

Download and install Docker Community Edition. If you have Homebrew-Cask, just type brew cask install docker. Or Download and install Docker Toolbox. Docker For Mac is nice, but it's not quite as finished as the VirtualBox install. See the comparison. NOTE Docker Toolbox is legacy. You should to use Docker Community Edition, See Docker Toolbox.

By default build for current platform and current arch. Use CLI flags --mac, --win, --linux to specify platforms. And --ia32, --x64 to specify arch.

For example, to build app for MacOS, Windows and Linux:

Build performed in parallel, so, it is highly recommended to not use npm task per platform (e.g. npm run dist:mac && npm run dist:win32), but specify multiple platforms/targets in one build command.You don’t need to clean dist output before build — output directory is cleaned automatically.

Sample .travis.yml to Build Electron App for macOS, Linux and Windows¶

Sample appveyor.yml to Build Electron App for Windows¶

Use AppVeyor only if:* you need to build AppX,* or your app has native dependency and prebuilt binary is not provided.

Otherwise see above sample .travis.yml to build Windows on Linux using provided Docker image.

macOS¶

All required system dependencies (except rpm) will be downloaded automatically on demand on macOS 10.12+ (macOS Sierra). On Travis, please add osx_image: xcode10.2 (see above sample .travis.yml).

To build rpm: brew install rpm (brew).

Linux¶

You can use Docker to avoid installing system dependencies.

Brewdock Berlin

To build app in distributable format for Linux:

To build rpm: sudo apt-get install --no-install-recommends -y rpm (or sudo yum install rpm-build).

To build pacman: sudo apt-get install --no-install-recommends -y bsdtar.

To build snap if and only if you have custom stage packages (if you don’t have custom snap build configuration, you don’t need to install). See snapcraft in Store.

To build app for Windows on Linux:¶

Docker (electronuserland/builder:wine) is recommended to avoid installing system dependencies.

• Install Wine (2.0+ is required) — see WineHQ Binary Packages.
• Install Mono (4.2+ is required) if you want to use Squirrel.Windows (NSIS, default target, doesn’t require mono).

To build app in 32 bit from a machine with 64 bit:¶

Brew Doctor Winnipeg

Travis Linux¶

Xenial is required.

Travis macOS¶

macOS 10.14+ is required.

Docker¶

To build Linux or Windows on any platform.

Warning

You cannot build for Windows using Docker if you have native dependencies and native dependency doesn’t use prebuild.

See example Docker usage on a CI server in the sample .travis.yml.

Note

Do not use Docker Toolbox on macOS. Only Docker for Mac works.

Build Electron App using Docker on a Local Machine¶

Brew Docker

1. Run docker container:

2. Type in yarn && yarn dist

If you don’t have dist npm script in your package.json, call ./node_modules/.bin/electron-builder directly.

Or to avoid second step, append to first command /bin/bash -c 'yarn && yarn dist' You can use /test.sh to install dependencies and run tests.

Tip

If you don’t need to build Windows, use image electronuserland/builder (wine is not installed in this image).

Provided Docker Images¶

Brew Doctor Kombucha Portland

• electronuserland/builder or electronuserland/builder:12 — NodeJS 10 and required system dependencies. Based on builder:base. Use this image if you need to build only Linux targets.
• electronuserland/builder:wine — Wine, NodeJS 10 and required system dependencies. Based on builder:10. Use this image if you need to build Windows targets.
• electronuserland/builder:wine-mono — Mono for Squirrel.Windows. Based on builder:wine. Use this image if you need to build Squirrel.Windows target.
• electronuserland/builder:wine-chrome — google-chrome-stable and xvfb are available — you can use this image for headless testing of Electron application. Based on builder:wine.
• electronuserland/builder:base — Required system dependencies. Not supposed to be used directly.