Skip to content

electron/electron

Folders and files

NameName
Last commit message
Last commit date
Oct 15, 2024
Jan 29, 2025
Jun 1, 2022
Jan 24, 2025
Feb 6, 2024
Jan 24, 2025
Oct 15, 2024
Jan 29, 2025
Jan 29, 2025
Nov 13, 2024
Jan 30, 2025
Jan 29, 2025
Jan 30, 2025
Aug 12, 2024
Jan 24, 2025
Jan 24, 2025
May 15, 2024
Oct 4, 2016
Apr 26, 2023
Dec 9, 2020
Jul 15, 2024
Oct 3, 2024
Mar 8, 2022
Dec 12, 2024
Dec 12, 2024
May 10, 2024
Nov 1, 2024
Jun 27, 2024
Nov 20, 2017
Nov 20, 2024
May 28, 2024
Nov 22, 2024
Jan 29, 2025
Feb 12, 2021
Aug 2, 2024
Nov 16, 2022
Jan 24, 2025
Apr 6, 2022
Oct 29, 2024
Jan 24, 2025
Jan 24, 2025
Mar 25, 2022
Jan 24, 2025
Aug 15, 2023
Nov 30, 2023
Nov 13, 2024
Aug 31, 2023
Feb 6, 2019
Sep 26, 2024
Oct 29, 2020
Aug 16, 2022
Nov 19, 2024

Repository files navigation

Electron Logo

GitHub Actions Build Status AppVeyor Build Status Electron Discord Invite

πŸ“ 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 Visual Studio Code and many other apps.

Follow @electronjs on 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 coc@electronjs.org.

Installation

To install prebuilt Electron binaries, use npm. 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 provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8. Support for Windows 7, 8 and 8.1 was removed 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

Use 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 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

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:

const electron = require('electron')
const proc = require('node:child_process')

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

// spawn Electron
const child = proc.spawn(electron)

Mirrors

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.

Contributing

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.

Community

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

License

MIT

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