Build Instructions (macOS)

Follow the guidelines below for building Electron on macOS.

Prerequisites

macOS >= 10.8
Xcode >= 5.1
node.js (external)

If you are using the Python downloaded by Homebrew, you also need to install the following Python modules:

pyobjc

Getting the Code

$ git clone https://github.com/electron/electron

Bootstrapping

The bootstrap script will download all necessary build dependencies and create the build project files. Notice that we're using ninja to build Electron so there is no Xcode project generated.

$ cd electron
$ ./script/bootstrap.py -v

Building

Build both Release and Debug targets:

$ ./script/build.py

You can also only build the Debug target:

$ ./script/build.py -c D

After building is done, you can find Electron.app under out/D.

32bit Support

Electron can only be built for a 64bit target on macOS and there is no plan to support 32bit macOS in the future.

Cleaning

To clean the build files:

$ npm run clean

Tests

Test your changes conform to the project coding style using:

$ npm run lint

Test functionality using:

$ npm test

You can make the test suite run faster by isolating the specific test or block you're currently working on using Mocha's exclusive tests feature:

describe.only('some feature', function () {
  // ... only tests in this block will be run
})

Alternatively, you can use mocha's grep option to only run tests matching the given regular expression pattern:

npm test -- --grep child_process

1.8 KiB Raw Blame History