Follow the guidelines below for building Electron on Windows.
depot_tools
setup instructions linked below, you will need
to use your locally installed Python with at least version 2.7.10 (with
support for TLS 1.2). To do so, make sure that in PATH, your locally
installed Python comes before the depot_tools
folder. Right now
depot_tools
still comes with Python 2.7.6, which will cause the gclient
command to fail (see https://crbug.com/868864).Debugging Tools for Windows of Windows SDK 10.0.15063.468 if you plan on
creating a full distribution since symstore.exe
is used for creating a symbol
store from .pdb
files.
Change
→ Individual Components
, scroll down and select the appropriate
Windows SDK to install. Another option would be to look at the
Windows SDK and emulator archive
and download the standalone version of the SDK respectively.Control Panel
→ Programs
→ Programs and Features
→ Select the "Windows Software Development Kit" →
Change
→ Change
→ Check "Debugging Tools For Windows" → Change
.
Or, you can download the standalone SDK installer and use it to install the Debugging Tools.If you don't currently have a Windows installation, dev.microsoftedge.com has timebombed versions of Windows that you can use to build Electron.
Building Electron is done entirely with command-line scripts and cannot be done with Visual Studio. You can develop Electron with any editor but support for building with Visual Studio will come in the future.
Note: Even though Visual Studio is not used for building, it's still required because we need the build toolchains it provides.
To build for the 32bit target, you need to pass target_cpu = "x86"
as a GN
arg. You can build the 32bit target alongside the 64bit target by using a
different output directory for GN, e.g. out/Release-x86
, with different
arguments.
$ gn gen out/Release-x86 --args="import(\"//electron/build/args/release.gn\") target_cpu=\"x86\""
The other building steps are exactly the same.
To generate a Visual Studio project, you can pass the --ide=vs2017
parameter
to gn gen
:
$ gn gen out/Debug --ide=vs2017
If you encountered an error like Command xxxx not found
, you may try to use
the VS2015 Command Prompt
console to execute the build scripts.
Make sure you have the latest Visual Studio update installed.
Try reinstalling 32bit Node.js.
Creating that directory should fix the problem:
$ mkdir ~\AppData\Roaming\npm
You may get this error if you are using Git Bash for building, you should use PowerShell or VS2015 Command Prompt instead.
node.js has some extremely long pathnames, and by default git on windows doesn't handle long pathnames correctly (even though windows supports them). This should fix it:
$ git config --system core.longpaths true
This can happen during build, when Debugging Tools for Windows has been installed with Windows Driver Kit. Uninstall Windows Driver Kit and install Debugging Tools with steps described above.