License: MIT

Language: C++

Electron Logo

Travis Build Status AppVeyor Build Status devDependency Status Join the Electron Community on Slack

📝 Available Translations: Korean | Simplified Chinese | Brazilian Portuguese | Traditional Chinese | Spanish | Turkish | German

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


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.

Project Statistics

Sourcerank 2
Repository Size 0 Bytes
Stars 0
Forks 0
Watchers 1
Open issues 1
Dependencies 34
Contributors 422
Tags 302
Last updated
Last pushed

Top Contributors See all

Cheng Zhao Kevin Sawicki Robo Zeke Sikelianos Plusb Preco Adam Roben Haojian Wu Paul Betts Samuel Attard =^._.^= Heilig Benedek J Gellert Hegyi Charlie Hess Eran Tiktin Felix Rieseberg Ryohei Ikegami Birunthan Mohanathas Josh Abernathy Shelley Vohr

Recent Tags See all

v1.6.15 October 11, 2017
v1.7.9 October 10, 2017
v1.8.1 September 28, 2017
v1.6.14 September 27, 2017
v1.7.8 September 24, 2017
v1.6.13 September 06, 2017
v1.8.0 August 31, 2017
v1.7.7 August 30, 2017
v1.7.6 August 09, 2017
v1.6.12 August 03, 2017
v1.7.5 July 17, 2017
v1.7.4 June 28, 2017
v1.7.3 June 08, 2017
v1.7.2 May 26, 2017
v1.6.11 May 25, 2017

Something wrong with this page? Make a suggestion

Last synced: 2017-10-15 00:45:41 UTC

Login to resync this repository