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 Newer CI images (#12188) Mar 9, 2018
.github Add config for trop (backporting bot) (#12238) Mar 13, 2018
atom Fix non-draggable regions on macOS (#12327) Mar 16, 2018
brightray Use same delay-load settings in both debug and release Mar 16, 2018
chromium_src Remove chrome_utility_messages.h, it's unused Feb 23, 2018
default_app Replace default_app icon Dec 7, 2017
docs-translations update references to renamed i18n repo Mar 2, 2018
docs Update example code (#12315) Mar 15, 2018
lib Check menu.popup options are an object (#12325) Mar 16, 2018
npm revert electron-download dependency to ^3.0.1 Nov 3, 2017
script Fix AttributeError: 'dict' object has no attribute 'required' Mar 15, 2018
spec Check menu.popup options are an object (#12325) Mar 16, 2018
tools Remove needless quotes around electron key Feb 22, 2018
vendor Use InternalCallbackScope for ticking event loop Mar 9, 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 Change Contact Emails (#12278) Mar 14, 2018
Dockerfile Newer CI images (#12188) Mar 9, 2018
Dockerfile.arm64 Newer CI images (#12188) Mar 9, 2018
Dockerfile.arm64v8 Allow CI building on arm64 hardware Mar 8, 2018
Dockerfile.armv7 Newer CI images (#12188) Mar 9, 2018
Dockerfile.circleci Newer CI images (#12188) Mar 9, 2018
Jenkinsfile Add 1 hour timeout Dec 4, 2017
Jenkinsfile.arm64 Allow CI building on arm64 hardware Mar 8, 2018
LICENSE Update license year Dec 31, 2017 Change Contact Emails (#12278) Mar 14, 2018 Change Contact Emails (#12278) Mar 14, 2018
common.gypi Use InternalCallbackScope for ticking event loop Mar 9, 2018
electron.gyp build node target for <(node_lib_target_name) Mar 9, 2018
features.gypi Make run-as-node mode optional (#11701) Jan 23, 2018
filenames.gypi mac: Call setMouseDownCanMoveWindow in BrowserWindow Mar 6, 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.