Build cross platform desktop apps with JavaScript, HTML, and CSS
C++ JavaScript Objective-C++ Python Objective-C HTML Other
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.circleci Update CI to use Node 8 Mar 19, 2018
.github Add config for trop (backporting bot) (#12238) Mar 13, 2018
atom Merge pull request #12348 from electron/fix-browser-view-draggable-re… Mar 20, 2018
brightray Ignore warning LNK4199 Mar 20, 2018
chromium_src move pdf viewer behind feature flag Mar 20, 2018
default_app Replace default_app icon Dec 7, 2017
docs-translations update references to renamed i18n repo Mar 2, 2018
docs Update 3 (of Visual Studio 2017) is leftover from 2015 (#12372) Mar 20, 2018
lib Remove the race condition between new process creation and context re… Mar 20, 2018
npm revert electron-download dependency to ^3.0.1 Nov 3, 2017
script add features module to detect availability of build time features at … Mar 20, 2018
spec add features module to detect availability of build time features at … Mar 20, 2018
tools Remove needless quotes around electron key Feb 22, 2018
vendor Update to the latest libcc with Ch63 Mar 20, 2018
.clang-format Add clang-format config file. Oct 4, 2016
.dockerignore Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
.gitignore Update sysroot to Debian Stretch Feb 23, 2018
.gitmodules Move brightray submodules to root vendor May 10, 2017
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. Nov 20, 2017
.travis.yml Add arm64 task in travis ci Aug 22, 2017 Change Contact Emails (#12278) Mar 14, 2018 add docs/development/ (#12373) Mar 20, 2018
Dockerfile Update CI to use Node 8 Mar 19, 2018
Dockerfile.arm64 Newer CI images (#12188) Mar 9, 2018
Dockerfile.arm64v8 Update CI to use Node 8 Mar 19, 2018
Dockerfile.armv7 Update CI to use Node 8 Mar 19, 2018
Dockerfile.circleci Update CI to use Node 8 Mar 19, 2018
Jenkinsfile Add 1 hour timeout Dec 4, 2017
Jenkinsfile.arm64 Update CI to use Node 8 Mar 19, 2018
LICENSE Update license year Dec 31, 2017 Change Contact Emails (#12278) Mar 14, 2018 Change Contact Emails (#12278) Mar 14, 2018
common.gypi Fix Windows linking error Mar 20, 2018
electron.gyp move pdf viewer behind feature flag Mar 20, 2018
features.gypi fixes offscreen rendering issues Mar 20, 2018
filenames.gypi Isolate the code using content::WebContentsImpl Mar 20, 2018
package.json Enable easy rebuild of native modules for unreleased electron (#12217) Mar 14, 2018
toolchain.gypi Fix error when cross compilation Feb 23, 2018

Electron Logo

CircleCI Build Status AppVeyor Build Status Jenkins Build Status devDependency Status Join the Electron Community on Slack

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹. View these docs in other languages at electron/i18n.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Atom editor and many other apps.

Follow @ElectronJS on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to


To install prebuilt Electron binaries, use npm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev --save-exact

The --save-exact flag is recommended as Electron does not follow semantic versioning. For info on how to manage Electron versions in your apps, see Electron versioning.

For more installation options and troubleshooting tips, see installation.

Quick start

Clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:

git clone
cd electron-quick-start
npm install
npm start

Resources for learning Electron

Programmatic usage

Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

const electron = require('electron')
const proc = require('child_process')

// will print something similar to /Users/maf/.../Electron

// spawn Electron
const child = proc.spawn(electron)


Documentation Translations

Find documentation translations in electron/i18n.


You can ask questions and interact with the community in the following locations:

Check out awesome-electron for a community maintained list of useful example apps, tools and resources.



When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.