Skip to content
:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
C++ TypeScript JavaScript Objective-C++ HTML Python Other
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci test: attempt to track down "illegal access" error (#23645) May 19, 2020
.github chore: note quiet period in PR template. (#23889) Jun 2, 2020
build build: fix filenames autogen with new BUILDFLAG syntax (#23952) Jun 3, 2020
buildflags fix: build when some buildflags are disabled (#23307) Apr 29, 2020
chromium_src chore: bump chromium to 580fe983e138952553cd6af11ee8b (master) (#23379) May 26, 2020
default_app build: enable JS semicolons (#22783) Mar 20, 2020
docs docs: remove confusing notes on Node (#23929) Jun 4, 2020
lib chore: remove IPC hiddens (#23720) Jun 2, 2020
npm fix: do not ignore electron exit signals in cli.js wrapper (#22878) Apr 13, 2020
patches chore: update tracking bug (#23959) Jun 4, 2020
script build: check patches on update (#23103) Jun 5, 2020
shell fix: throw instead of crash when using ipcRenderer after context rele… Jun 4, 2020
spec-main fix: throw instead of crash when using ipcRenderer after context rele… Jun 4, 2020
spec fix: compensate for lazy-loaded circular deps (#23890) Jun 3, 2020
tools build: use autogenerated docker images for CI runs (#21056) Nov 13, 2019
typings chore: tsify sandboxed init (#23719) May 30, 2020
vendor chore: temporarily use submodule and gn DEPS for requests/boto Oct 6, 2018
.clang-format Add clang-format config file. Oct 4, 2016
.dockerignore build: remove scripts in the tools dir that are unused (#18944) Jun 23, 2019
.env.example build: move Windows release builds to AppVeyor cloud (#18337) May 23, 2019
.eslintrc.json build: allow use of BUILDFLAG directives from within JS code (#20328) May 10, 2020
.gitattributes build: set merge=union for .patches (#22985) Apr 6, 2020
.gitignore build: make CI faster, magic contained within (#21086) Nov 28, 2019
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto Oct 6, 2018
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. Nov 20, 2017
BUILD.gn fix: restore original GTK/appindicator implementation of tray icons (#… Jun 3, 2020
CODE_OF_CONDUCT.md docs: update code of conduct (#23137) Apr 20, 2020
CONTRIBUTING.md docs: Update Issue Closure in CONTRIBUTING.md (#20545) Oct 14, 2019
DEPS chore: bump chromium to d66c2e32380bf5d1eb5e1fe37faef (master) (#23791) Jun 1, 2020
ELECTRON_VERSION Bump v11.0.0-nightly.20200604 Jun 4, 2020
LICENSE chore: update license year (#21657) Jan 3, 2020
README.md docs: update README.md (#20644) Oct 21, 2019
SECURITY.md Change Contact Emails (#12278) Mar 14, 2018
appveyor.yml test: attempt to track down "illegal access" error (#23645) May 19, 2020
azure-pipelines-woa.yml ci: deflake WOA tests (#23707) May 26, 2020
electron_paks.gni feat: enable pdf viewer (#21794) Feb 13, 2020
electron_resources.grd feat: enable pdf viewer (#21794) Feb 13, 2020
electron_strings.grdp feat: enable builtin spellchecker (#20692) Oct 31, 2019
filenames.auto.gni docs: move protocol-ns to protocol.md (#23883) Jun 2, 2020
filenames.gni refactor: remove the RenderFrameFunctionStore and use privates to mem… May 15, 2020
filenames.hunspell.gni chore: bump chromium to 98ebf6c3f0b7bd96bdb1a4b42208f (master) (#22999) Apr 13, 2020
package.json build: check patches on update (#23103) Jun 5, 2020
tsconfig.default_app.json chore: fix ts config to not complain about extraneous files (#16790) Feb 6, 2019
tsconfig.electron.json chore: fix ts config to not complain about extraneous files (#16790) Feb 6, 2019
tsconfig.json chore: convert more files to TypeScript (#18820) Jul 17, 2019
tsconfig.spec.json spec: initial spike of main-process based tests Mar 14, 2019
vsts-arm-test-steps.yml ci: fix crash on arm testing (#21407) Dec 5, 2019
vsts-arm32v7.yml build: use autogenerated docker images for CI runs (#21056) Nov 13, 2019
vsts-arm64v8.yml build: use autogenerated docker images for CI runs (#21056) Nov 13, 2019
yarn.lock build: fix for "enable_desktop_capturer = false" (#23864) Jun 1, 2020

README.md

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹 🇵🇱. View these docs in other languages at electron/i18n.

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 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 [--save-exact]

The --save-exact flag is recommended for Electron prior to version 2, as it does not follow semantic versioning. As of version 2.0.0, Electron follows semver, so you don't need --save-exact flag. For info on how to manage Electron versions in your apps, see Electron versioning.

For more installation options and troubleshooting tips, see installation.

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

Documentation Translations

Find documentation translations in electron/i18n.

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 in the support document.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.

You can’t perform that action at this time.