Build cross-platform desktop apps with JavaScript, HTML, and CSS


Electron Logo
CircleCI Build Status AppVeyor Build Status Electron Discord Invite

:memo: Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪.
View these docs in other languages on our Crowdin project.

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](https://github.com/atom/atom) and many other apps.

Follow @electronjs on Twitter for important

This project adheres to the Contributor Covenant
By participating, you are expected to uphold this code. Please report unacceptable
behavior to coc@electronjs.org.


To install prebuilt Electron binaries, use [npm](https://docs.npmjs.com/).
The preferred method is to install Electron as a development dependency in your

  1. ```sh
  2. npm install electron --save-dev
  3. ```

For more installation options and troubleshooting tips, see
installation. For info on how to manage Electron versions in your apps, see

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

macOS (High Sierra and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11.
Windows (Windows 7 and up): Electron provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8.
Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
  Ubuntu 14.04 and newer
  Fedora 24 and newer
  Debian 8 and newer

Quick start & Electron Fiddle

Use [Electron Fiddle](https://github.com/electron/fiddle)
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
Electron easier.

Alternatively, clone and run the
repository to see a minimal Electron app in action:

  1. ```sh
  2. git clone https://github.com/electron/electron-quick-start
  3. cd electron-quick-start
  4. npm install
  5. npm start
  6. ```

Resources for learning Electron

electronjs.org/docs - All of Electron's documentation
electron/fiddle - A tool to build, run, and package small Electron experiments
electron/electron-quick-start - A very basic starter Electron app
electronjs.org/community#boilerplates - Sample starter apps created by the community

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:

  1. ``` js
  2. const electron = require('electron')
  3. const proc = require('child_process')

  4. // will print something similar to /Users/maf/.../Electron
  5. console.log(electron)

  6. // spawn Electron
  7. const child = proc.spawn(electron)
  8. ```


See the Advanced Installation Instructions to learn how to use a custom mirror.

Documentation translations

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.