📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on ourCrowdinproject.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based onNode.jsand Chromiumand is used by the Visual Studio Codeand many otherapps.

Follow@electronjson 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[email protected].

Installation

To install prebuilt Electron binaries, usenpm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev

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

Platform support

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

• macOS (Big Sur and up): Electron provides 64-bit Intel and Apple Silicon / ARM binaries for macOS.
• Windows (Windows 10 and up): Electron providesia32(x86),x64(amd64), andarm64binaries for Windows. Windows on ARM support was added in Electron 5.0.8. Support for Windows 7, 8 and 8.1 wasremoved in Electron 23, in line with Chromium's Windows deprecation policy.
• Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
  • Ubuntu 18.04 and newer
  • Fedora 32 and newer
  • Debian 10 and newer

Quick start & Electron Fiddle

UseElectron 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 electron/electron-quick-start repository to see a minimal Electron app in action:

git clone https://github /electron/electron-quick-start
cdelectron-quick-start
npm install
npm start

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 requireelectroninside yourNode app(not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

constelectron=require('electron')
constproc=require('node:child_process')

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

// spawn Electron
constchild=proc.spawn(electron)

Mirrors

• China

See theAdvanced Installation Instructionsto learn how to use a custom mirror.

Documentation translations

We crowdsource translations for our documentation viaCrowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.

Contributing

If you are interested in reporting/fi xing issues and contributing directly to the code base, please seeCONTRIBUTING.mdfor more information on what we're looking for and how to get started.

Community

Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found on theCommunity page.

License

MIT

When using Electron logos, make sure to followOpenJS Foundation Trademark Policy.