Follow @ElectronJS on Twitter for important announcements.
To install prebuilt Electron binaries, use
The preferred method is to install Electron as a development dependency in your
npm install electron --save-dev --save-exact
--save-exact flag is recommended as Electron does not follow semantic
versioning. For info on how to manage Electron versions in your apps, see
For more installation options and troubleshooting tips, see installation.
Clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:
git clone https://github.com/electron/electron-quick-start cd electron-quick-start npm install npm start
Resources for learning Electron
- electronjs.org/docs - all of Electron's documentation
- electron/electron-quick-start - a very basic starter Electron app
- electronjs.org/community#boilerplates - sample starter apps created by the community
- electron/simple-samples - small applications with ideas for taking them further
- electron/electron-api-demos - an Electron app that teaches you how to use Electron
- hokein/electron-sample-apps - small demo apps for the various Electron APIs
Most people use Electron from the command line, but if you require
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 console.log(electron) // spawn Electron const child = proc.spawn(electron)
Find documentation translations in electron/electron-i18n.
You can ask questions and interact with the community in the following locations:
electroncategory on the Atom forums
#atom-shellchannel on Freenode
Atomchannel on Slack
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.