• Stars
    star
    112,229
  • Rank 41 (Top 0.01 %)
  • Language
    C++
  • License
    MIT License
  • Created over 11 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

Electron Logo

CircleCI 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 Atom editor 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].

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 (High Sierra 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 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 14.04 and newer
    • Fedora 24 and newer
    • Debian 8 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('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.

More Repositories

1

electron-quick-start

Clone to try a simple Electron app
JavaScript
10,965
star
2

electron-api-demos

Explore the Electron APIs
HTML
10,247
star
3

fiddle

:electron: πŸš€ The easiest way to get started with Electron
TypeScript
7,361
star
4

forge

:electron: A complete tool for building and publishing Electron applications
TypeScript
6,282
star
5

asar

Simple extensive tar-like archive format with indexing
JavaScript
2,480
star
6

apps

A collection of apps built on Electron
JavaScript
1,663
star
7

electronjs.org-old

Electron website
Handlebars
1,598
star
8

rcedit

Command line tool to edit resources of exe
C++
1,573
star
9

windows-installer

Build Windows Installers for Electron apps
TypeScript
1,536
star
10

electron-quick-start-typescript

Clone to try a simple Electron app (in TypeScript)
TypeScript
1,179
star
11

rebuild

Package to rebuild native Node.js modules against the currently installed Electron version
TypeScript
993
star
12

update-electron-app

🌲 A drop-in module that adds autoUpdating capabilities to Electron apps
TypeScript
704
star
13

i18n

🌍 The home of Electron's translated documentation
TypeScript
625
star
14

simple-samples

Minimal Electron applications with ideas for taking them further
JavaScript
608
star
15

update.electronjs.org

πŸ“‘ A free service that makes it easy for open-source Electron apps to update themselves.
JavaScript
575
star
16

osx-sign

Codesign Electron macOS apps
TypeScript
548
star
17

libchromiumcontent

Shared library build of Chromium’s Content module
Python
485
star
18

remote

Bridge JavaScript objects from the main process to the renderer process in Electron.
TypeScript
359
star
19

get

Download Electron release artifacts
TypeScript
332
star
20

build-tools

The GN scripts to use for Electron dev-flows
JavaScript
250
star
21

releases

πŸ“¦ Complete and up-to-date info about every release of Electron
JavaScript
245
star
22

mini-breakpad-server

Minimum breakpad crash reports collecting server
CoffeeScript
240
star
23

node

Node fork to make it suitable for embedding in Electron
231
star
24

node-rcedit

Node module to edit resources of exe
JavaScript
186
star
25

node-abi

🐒 πŸš€ Get the Node.js and Electron ABI for a given target and runtime
JavaScript
157
star
26

governance

Public repository for governance issues and documents
Shell
138
star
27

sheriff

Controls and monitors organization permissions across GitHub, Slack and GSuite. Built with ❀️ by The Electron Team
TypeScript
134
star
28

chromedriver

Download ChromeDriver for Electron
JavaScript
129
star
29

typescript-definitions

Convert the Electron API JSON file to electron.d.ts
TypeScript
125
star
30

packager

Customize and package your Electron app with OS-specific bundles (.app, .exe, etc.) via JS or CLI
TypeScript
123
star
31

notarize

Notarize your macOS Electron Apps
TypeScript
112
star
32

universal

Create Universal macOS applications from two x64 and arm64 Electron applications
TypeScript
109
star
33

mksnapshot

Electron mksnapshot binaries
JavaScript
102
star
34

website

:electron: The Electron website
TypeScript
102
star
35

trop

automate the backporting process
TypeScript
72
star
36

node-minidump

Node module to process minidump files
JavaScript
68
star
37

pdf-viewer

Fork of Chrome pdf extension to work as webui page in Electron
JavaScript
51
star
38

clerk

Verify PRs have release notes
TypeScript
48
star
39

hubdown

Convert markdown to GitHub-style HTML using a common set of remark plugins
JavaScript
39
star
40

native-mate

Fork of Chromium's gin library that makes it easier to marshal types between C++ and JavaScript.
C++
38
star
41

download-stats

⬇️ Download stats for Electron. Updated daily.
JavaScript
35
star
42

fuses

TypeScript
33
star
43

crashpad

Electron fork of crashpad
C++
31
star
44

symbolicate-mac

Symbolicate macOS Electron crash reports
JavaScript
30
star
45

onboarding-guide

or, "So You Want to Be an Electron Hacker"
30
star
46

chromium-breakpad

GitHub clone of the breakpad used by Chromium
C++
29
star
47

node-chromium-pickle-js

Binary value packing and unpacking library compatible with Chromium's Pickle class
JavaScript
22
star
48

electron-docs-linter

Parse and validate Electron's API documentation
JavaScript
21
star
49

docs-parser

Parse Electron docs in a lossless way into a JSON file
TypeScript
20
star
50

nightlies

Nightly release store
19
star
51

be

Scripts to help building Electron
JavaScript
18
star
52

season-of-docs-2020

πŸ“– Project repository for Electron's possible participation in Google's Season of Docs
18
star
53

windows-sign

Codesign Electron apps for Windows
TypeScript
18
star
54

dependent-repos

Public GitHub repos that depend on Electron. spiritual successor to https://github.com/electron/repos-using-electron
JavaScript
18
star
55

debian-sysroot-image-creator

Scripts to create debian sysroot image for building electron
Shell
18
star
56

cation

Electron's PR monitoring bot
TypeScript
18
star
57

asar-require

Enable "require" scripts in asar archives
CoffeeScript
18
star
58

packages

A collection of all npm packages that mention `electron` in their package.json
JavaScript
17
star
59

symbol-server

Electron symbol server
TypeScript
15
star
60

unreleased

Checks for and reports commits unreleased for a specific release branch.
JavaScript
13
star
61

archaeologist

Digging up your artifacts since 2018
TypeScript
13
star
62

algolia-indices

Algolia search index data for Electron APIs, Tutorials, Packages, and Repos
JavaScript
13
star
63

fiddle-core

Run fiddles from anywhere, on any Electron release
TypeScript
13
star
64

electron-frameworks

Frameworks used by Electron
11
star
65

github-app-auth

Gets an auth token for a repo via a GitHub app installation
TypeScript
10
star
66

search-with-your-keyboard

Add keyboard navigation to your existing client-side search interface.
JavaScript
10
star
67

build-images

Base docker image used to build Electron on CI
Shell
10
star
68

electron-api-historian

Find the birthday of every Electron API
JavaScript
9
star
69

gyp

Python
9
star
70

electron-api-docs

πŸ“ Electron's API documentation in a structured JSON format [ARCHIVED]
JavaScript
9
star
71

build-tools-installer

Installer for Electron's wrapper toolkit for working with Electron.js source code
JavaScript
9
star
72

electron-docs

Fetch Electron documentation as raw markdown strings
JavaScript
8
star
73

.github

organization-wide defaults for all electron/* repos
7
star
74

rfcs

7
star
75

bugbot

Making life easier for people who report or triage Electron issues.
TypeScript
6
star
76

node-is-valid-window

Validates if a pointer to window is valid.
C++
5
star
77

electron-translators

Everyone who has helped translate Electron's documentation into different languages.
JavaScript
5
star
78

eslint-config

ESLint config used by Electron and Electron maintained modules
JavaScript
5
star
79

circleci-oidc-secret-exchange

Provides dynamic access to secrets in exchange for a valid OIDC token
TypeScript
5
star
80

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
star
81

roller

🎡rollin on upstream 🎡
TypeScript
4
star
82

lint-roller

JavaScript
3
star
83

github-app-auth-action

TypeScript
3
star
84

tweets

3
star
85

electron-website-updater

JavaScript
3
star
86

zoilist

Nag @electron/api-wg to do API reviews
TypeScript
3
star
87

libcc-check

A little tool for checking up on libchromiumcontent builds.
JavaScript
2
star
88

slack-chromium-helper

Slack bot to unfurl Chromium development URLs
TypeScript
2
star
89

release-status

Public facing release status information
JavaScript
2
star
90

electron-issues

An experiment to better understand the issues filed on the electron/electron repo
JavaScript
2
star
91

hippo

TypeScript
2
star
92

ventifact

TypeScript
2
star
93

node-orb

Shell
1
star
94

electron-notarize

Notarize your macOS Electron Apps
TypeScript
1
star
95

docs-reviewer

TypeScript
1
star