📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages at electron/i18n.
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
Each Electron release provides binaries for macOS, Windows, and Linux.
arm64binaries for Windows. Windows on ARM support was added in Electron 5.0.8.
to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and
to try out different versions of Electron. It's designed to make the start of your journey with
Alternatively, 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 startResources for learning Electron
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')Mirrors
// will print something similar to /Users/maf/.../Electron console.log(electron)
// spawn Electron const child = proc.spawn(electron)
See the Advanced Installation Instructions to learn how to use a custom mirror.
We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.
If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.
Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found on the Community page.
When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.