Skip to content
:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: do not use the MOCHA_FILE env variable (#19171) Jul 9, 2019
.github docs: mention fiddle in bug report template (#19248) Jul 16, 2019
build chore: update to latest TypeScript 3.5.2 (#19133) Jul 9, 2019
buildflags fix: port OSR code to new viz compositor codepath (#17538) Apr 17, 2019
chromium_src chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) Jul 3, 2019
components/pepper_flash chore: fix linking errors on Windows Feb 14, 2019
default_app fix: app.getAppPath() returning default-app path for files or directo… Jun 19, 2019
docs-translations update references to renamed i18n repo Mar 2, 2018
docs docs: update Electron Packager links (#19333) Jul 20, 2019
lib chore: convert more files to TypeScript (#18820) Jul 17, 2019
native_mate docs: replace the atom.io headers URL with electronjs.org (#18328) May 21, 2019
npm build: ensure that we bundle the correct version of @types/node (#19102) Jul 3, 2019
patches fix: bootstrap the node environment after we setup the InspectorAgent ( Jul 18, 2019
script test: run all tests on arm linux platforms (#19318) Jul 19, 2019
shell Bump v7.0.0-nightly.20190720 Jul 20, 2019
spec-main test: robustify MenuItem label/accel tests (#19287) Jul 17, 2019
spec chore: upgrade transitive lodash dependency (#19297) Jul 18, 2019
tools chore: update to Node.js v12.4.0 (#18924) Jul 16, 2019
typings chore: convert more files to TypeScript (#18820) Jul 17, 2019
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: ensure consistent lock files across multiple machines (#17955) Apr 30, 2019
.gitattributes chore: force patches to be checked out with LF line endings (#14789) Sep 25, 2018
.gitignore build: ensure consistent lock files across multiple machines (#17955) Apr 30, 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 build: update symbol generation logic for all helpers (#19336) Jul 19, 2019
CODE_OF_CONDUCT.md Change Contact Emails (#12278) Mar 14, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Jun 19, 2019
DEPS chore: upgrade node to 12.6.0 (#19312) Jul 17, 2019
Dockerfile chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) Jul 3, 2019
Dockerfile.arm32v7 ci: use ubuntu 18.04 for arm testing (#14988) Oct 5, 2018
Dockerfile.arm64v8 test: run all tests on arm linux platforms (#19318) Jul 19, 2019
ELECTRON_VERSION Bump v7.0.0-nightly.20190720 Jul 20, 2019
LICENSE fix: update license year (#16287) Jan 5, 2019
README.md docs: update badges (#18955) Jun 24, 2019
SECURITY.md Change Contact Emails (#12278) Mar 14, 2018
appveyor.yml fix: dump correct breakpad symbols on macOS (#19042) Jul 5, 2019
electron_paks.gni chore: bump chromium to 2a7aff41ce73adc0eeee67d364989 (master) (#18505) Jun 4, 2019
electron_resources.grd chore: use c++ manifests instead of json Feb 14, 2019
electron_strings.grdp chore: bump chromium to 2a7aff41ce73adc0eeee67d364989 (master) (#18505) Jun 4, 2019
filenames.auto.gni chore: convert more files to TypeScript (#18820) Jul 17, 2019
filenames.gni chore: use dummy WebRequestNS when NetworkService is enabled (#19300) Jul 17, 2019
package.json Bump v7.0.0-nightly.20190720 Jul 20, 2019
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 test: run all tests on arm linux platforms (#19318) Jul 19, 2019
vsts-arm32v7.yml chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) Jul 3, 2019
vsts-arm64v8.yml test: run all tests on arm linux platforms (#19318) Jul 19, 2019
yarn.lock chore: upgrade transitive lodash dependency (#19297) Jul 18, 2019

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.