Repository files navigation

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

The Electron framework lets you write cross-platform desktop applicationsusing JavaScript, HTML and CSS. It is based onNode.js andChromium and is used by theVisual StudioCode and many otherapps.

Follow@electronjs on Twitter for importantannouncements.

This project adheres to the Contributor Covenantcode of conduct.By participating, you are expected to uphold this code. Please report unacceptablebehavior tococ@electronjs.org.

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

npm install electron --save-dev

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

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

• macOS (Catalina and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11.
• Windows (Windows 10 and up): Electron providesia32 (x86),x64 (amd64), andarm64 binaries 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

UseElectron Fiddleto build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, andto try out different versions of Electron. It's designed to make the start of your journey withElectron easier.

Alternatively, clone and run theelectron/electron-quick-startrepository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-startcd electron-quick-startnpm installnpm start

• 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

Most people use Electron from the command line, but if you requireelectron insideyourNode app (not your Electron app) it will return the file path to thebinary. Use this to spawn Electron from Node scripts:

constelectron=require('electron')constproc=require('node:child_process')// will print something similar to /Users/maf/.../Electronconsole.log(electron)// spawn Electronconstchild=proc.spawn(electron)

• China

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

We crowdsource translations for our documentation viaCrowdin.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 seeCONTRIBUTING.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 theCommunity page.

MIT

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