:memo: Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on our Crowdin project. The Electron framework lets you write cross-platform desktop applications…



: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
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 [[email protected]](mailto:[email protected]).
Installation
To install prebuilt Electron binaries, use npm.
The preferred method is to install Electron as a development dependency in your
app:
sh
npm install electron --save-dev
For more installation options and troubleshooting tips, see
[installation](docs/tutorial/installation.md). For info on how to manage Electron versions in your apps, see
[Electron versioning](docs/tutorial/electron-versioning.md).
Platform support
Each Electron release provides binaries for macOS, Windows, and Linux.
- macOS (Ventura 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), andarm64binaries 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 22.04. They have also been verified to work on:
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.
Resources for learning Electron
- electronjs.org/docs - All of Electron's documentation
- electron/fiddle - A tool to build, run, and package small Electron experiments
- 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:
javascript
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](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
When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.
Members
-
electron
:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
C++ ★ 122k 1d agoExplain → -
minimal-repro
Clone to try a simple Electron app
JavaScript ★ 11k 23h agoExplain → -
electron-api-demos ▣
Explore the Electron APIs
HTML ★ 10k 3y agoExplain → -
fiddle
:electron: 🚀 The easiest way to get started with Electron
TypeScript ★ 7.7k 4d agoExplain → -
forge
:electron: A complete tool for building and publishing Electron applications
TypeScript ★ 7.1k 15h agoExplain → -
asar
Simple extensive tar-like archive format with indexing
TypeScript ★ 2.8k 4d agoExplain → -
rcedit ▣
Command line tool to edit resources of exe
C++ ★ 2.1k 2mo agoExplain → -
devtron
An Electron DevTools Extension
TypeScript ★ 1.8k 1d agoExplain → -
apps
A collection of apps built on Electron
JavaScript ★ 1.7k 1mo agoExplain → -
electronjs.org-old ▣
Electron website
Handlebars ★ 1.7k 3y agoExplain → -
windows-installer
Build Windows Installers for Electron apps
TypeScript ★ 1.6k 1mo agoExplain → -
electron-quick-start-typescript ▣
Clone to try a simple Electron app (in TypeScript)
TypeScript ★ 1.2k 2y agoExplain → -
rebuild
Package to rebuild native Node.js modules against the currently installed Electron version
TypeScript ★ 1.1k 1d agoExplain → -
update-electron-app
🌲 A drop-in module that adds autoUpdating capabilities to Electron apps
TypeScript ★ 822 1mo agoExplain → -
update.electronjs.org
📡 A free service that makes it easy for open-source Electron apps to update themselves.
TypeScript ★ 696 19d agoExplain → -
osx-sign
Codesign Electron macOS apps
TypeScript ★ 623 5d agoExplain → -
i18n ▣
🌍 The home of Electron's translated documentation
TypeScript ★ 619 3y agoExplain → -
simple-samples ▣
Minimal Electron applications with ideas for taking them further
JavaScript ★ 604 6y agoExplain → -
libchromiumcontent ▣
Shared library build of Chromium’s Content module
Python ★ 486 3y agoExplain → -
remote
Bridge JavaScript objects from the main process to the renderer process in Electron.
TypeScript ★ 409 1mo agoExplain → -
get
Download Electron release artifacts
TypeScript ★ 364 21h agoExplain → -
packager
Customize and package your Electron app with OS-specific bundles (.app, .exe, etc.) via JS or CLI
TypeScript ★ 299 3d agoExplain → -
build-tools
The GN scripts to use for Electron dev-flows
JavaScript ★ 298 2d agoExplain → -
mini-breakpad-server ▣
Minimum breakpad crash reports collecting server
CoffeeScript ★ 252 3y agoExplain → -
node ▣
Node fork to make it suitable for embedding in Electron
★ 240 6y agoExplain → -
releases ▣
📦 Complete and up-to-date info about every release of Electron
JavaScript ★ 239 3y agoExplain → -
node-rcedit ▣
Node module to edit resources of exe
JavaScript ★ 197 2mo agoExplain → -
notarize
Notarize your macOS Electron Apps
TypeScript ★ 191 5d agoExplain → -
node-abi
:turtle: :rocket: Get the Node.js and Electron ABI for a given target and runtime
JavaScript ★ 183 1mo agoExplain → -
governance
Public repository for governance issues and documents
Shell ★ 162 11d agoExplain → -
website
:electron: The Electron website
TypeScript ★ 155 1d agoExplain → -
sheriff
Controls and monitors organization permissions across GitHub, Slack and GSuite. Built with ❤️ by The Electron Team
TypeScript ★ 152 9d agoExplain → -
universal
Create Universal macOS applications from two x64 and arm64 Electron applications
TypeScript ★ 149 5d agoExplain → -
chromedriver
Download ChromeDriver for Electron
JavaScript ★ 143 4d agoExplain → -
typescript-definitions
Convert the Electron API JSON file to electron.d.ts
TypeScript ★ 132 4d agoExplain → -
mksnapshot
Electron mksnapshot binaries
JavaScript ★ 112 4d agoExplain → -
llm
No description.
TypeScript ★ 90 19d agoExplain → -
trop
automate the backporting process
TypeScript ★ 87 1d agoExplain → -
node-minidump
Node module to process minidump files
JavaScript ★ 79 1d agoExplain → -
windows-sign
Codesign Electron apps for Windows
TypeScript ★ 65 1d agoExplain → -
clerk
Verify PRs have release notes
TypeScript ★ 61 4d agoExplain → -
fuses
No description.
TypeScript ★ 54 4d agoExplain → -
pdf-viewer ▣
Fork of Chrome pdf extension to work as webui page in Electron
JavaScript ★ 52 7y agoExplain → -
download-stats
⬇️ Download stats for Electron. Updated daily.
JavaScript ★ 41 12h agoExplain → -
hubdown ▣
Convert markdown to GitHub-style HTML using a common set of remark plugins
JavaScript ★ 41 3y agoExplain → -
onboarding-guide
or, "So You Want to Be an Electron Hacker"
★ 38 3y agoExplain → -
symbolicate-mac
Symbolicate macOS Electron crash reports
JavaScript ★ 37 5d agoExplain → -
native-mate ▣
Fork of Chromium's gin library that makes it easier to marshal types between C++ and JavaScript.
C++ ★ 37 7y agoExplain → -
crashpad ▣
Electron fork of crashpad
C++ ★ 32 7y agoExplain → -
docs-parser
Parse Electron docs in a lossless way into a JSON file
TypeScript ★ 29 3d agoExplain → -
chromium-breakpad ▣
GitHub clone of the breakpad used by Chromium
C++ ★ 29 8y agoExplain → -
symbol-server
Electron symbol server
JavaScript ★ 25 9d agoExplain → -
debian-sysroot-image-creator
Scripts to create debian sysroot image for building electron
Python ★ 24 12d agoExplain → -
node-chromium-pickle-js ▣
Binary value packing and unpacking library compatible with Chromium's Pickle class
JavaScript ★ 24 5y agoExplain → -
nightlies
Nightly release store
★ 23 3d agoExplain → -
fiddle-core
Run fiddles from anywhere, on any Electron release
TypeScript ★ 22 5d agoExplain → -
build-images
Base docker image used to build Electron on CI
Shell ★ 22 5d agoExplain → -
cation
Electron's PR monitoring bot
TypeScript ★ 21 4d agoExplain → -
electron-docs-linter ▣
Parse and validate Electron's API documentation
JavaScript ★ 21 3y agoExplain → -
be
Scripts to help building Electron
JavaScript ★ 19 2y agoExplain → -
dependent-repos ▣
Public GitHub repos that depend on Electron. spiritual successor to https://github.com/electron/repos-using-electron
JavaScript ★ 19 3y agoExplain → -
asar-require ▣
Enable "require" scripts in asar archives
CoffeeScript ★ 18 10y agoExplain → -
season-of-docs-2020 ▣
:book: Project repository for Electron's possible participation in Google's Season of Docs
★ 18 6y agoExplain → -
unreleased
Checks for and reports commits unreleased for a specific release branch.
JavaScript ★ 17 22d agoExplain → -
packages ▣
A collection of all npm packages that mention `electron` in their package.json
JavaScript ★ 17 8y agoExplain → -
release-status
Public facing release status information
TypeScript ★ 16 2d agoExplain → -
github-app-auth
Gets an auth token for a repo via a GitHub app installation
TypeScript ★ 16 3d agoExplain → -
archaeologist
Digging up your artifacts since 2018
TypeScript ★ 16 9d agoExplain → -
rfcs
No description.
★ 16 25d agoExplain → -
build-tools-installer
Installer for Electron's wrapper toolkit for working with Electron.js source code
JavaScript ★ 15 1mo agoExplain → -
algolia-indices ▣
Algolia search index data for Electron APIs, Tutorials, Packages, and Repos
JavaScript ★ 13 5y agoExplain → -
electron-frameworks ▣
Frameworks used by Electron
★ 11 6y agoExplain → -
gyp ▣
No description.
Python ★ 10 7y agoExplain → -
search-with-your-keyboard ▣
Add keyboard navigation to your existing client-side search interface.
JavaScript ★ 10 3y agoExplain → -
node-gyp ▣
No description.
Python ★ 9 9mo agoExplain → -
electron-api-historian ▣
Find the birthday of every Electron API
JavaScript ★ 9 3y agoExplain → -
electron-api-docs ▣
:memo: Electron's API documentation in a structured JSON format [ARCHIVED]
JavaScript ★ 9 8y agoExplain → -
roller
🎵rollin on upstream 🎵
TypeScript ★ 8 5d agoExplain → -
github-app-auth-action
No description.
TypeScript ★ 8 7d agoExplain → -
eslint-config ▣
ESLint config used by Electron and Electron maintained modules
JavaScript ★ 8 1mo agoExplain → -
bugbot ▣
Making life easier for people who report or triage Electron issues.
TypeScript ★ 8 2y agoExplain → -
electron-docs ▣
Fetch Electron documentation as raw markdown strings
JavaScript ★ 8 5y agoExplain → -
zoilist
Nag @electron/api-wg to do API reviews
TypeScript ★ 7 2d agoExplain → -
.github
organization-wide defaults for all electron/* repos
★ 7 23d agoExplain → -
lint-roller
No description.
JavaScript ★ 6 5d agoExplain → -
electron-website-updater ▣
No description.
JavaScript ★ 6 3mo agoExplain → -
circleci-oidc-secret-exchange ▣
Provides dynamic access to secrets in exchange for a valid OIDC token
TypeScript ★ 6 4mo agoExplain → -
electron-userland-reports ▣
Slices of data about packages, repos, and users in Electron userland. Collected from the GitHub API, npm registry, and libraries.io
JavaScript ★ 5 9y agoExplain → -
node-is-valid-window ▣
Validates if a pointer to window is valid.
C++ ★ 5 4y agoExplain → -
electron-translators ▣
Everyone who has helped translate Electron's documentation into different languages.
JavaScript ★ 5 9y agoExplain → -
hippo
No description.
TypeScript ★ 4 1mo agoExplain → -
extract-zip
No description.
JavaScript ★ 3 9d agoExplain → -
slack-chromium-helper
Slack bot to unfurl Chromium development URLs
TypeScript ★ 3 5d agoExplain → -
node-orb ▣
No description.
Shell ★ 3 9mo agoExplain → -
ventifact ▣
No description.
TypeScript ★ 3 2mo agoExplain → -
semantic-release-npm-cfa ⑂ ▣
:ship: semantic-release plugin to publish a npm package using CFA for OTP
JavaScript ★ 3 1y agoExplain → -
tweets ▣
No description.
★ 3 3y agoExplain → -
semantic-trusted-release
No description.
JavaScript ★ 2 8d agoExplain → -
secret-service-action
No description.
★ 2 23d agoExplain → -
patch-conflict-fixer
Bots are cool
TypeScript ★ 2 1mo agoExplain → -
docs-reviewer
No description.
TypeScript ★ 2 2mo agoExplain → -
Squirrel.Mac ⑂ ▣
:shipit: Cocoa framework for updating OS X apps :shipit:
Objective-C ★ 2 6y agoExplain → -
electron-issues ▣
An experiment to better understand the issues filed on the electron/electron repo
JavaScript ★ 2 9y agoExplain → -
libcc-check ▣
A little tool for checking up on libchromiumcontent builds.
JavaScript ★ 2 8y agoExplain → -
siso
No description.
Shell ★ 1 2mo agoExplain → -
chrome-security-rss
No description.
JavaScript ★ 1 2mo agoExplain → -
fsevents ⑂
Native access to MacOS FSEvents in Node.js
★ 1 2mo agoExplain → -
sccache ⑂ ▣
sccache is ccache with cloud storage
★ 1 6y agoExplain → -
npm-trusted-auth-action ▣
No description.
★ 0 9mo agoExplain → -
cfa-test ▣
No description.
TypeScript ★ 0 3y agoExplain → -
electron-community-discord-bot
No description.
★ 0 3y agoExplain →
No repos match these filters.