Build cross-platform desktop apps with JavaScript, HTML, and CSS
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.circleci ci: Fix timeout when generating breakpad symbols (#15126) Oct 13, 2018
.github chore: update pr template for no-notes (#15137) Oct 13, 2018
.vsts chore: add GN linting (#14678) Oct 3, 2018
atom fix: don't call ReadRawDataComplete if it's not necessary (#15185) Oct 17, 2018
brightray fix: disable the V2 sandbox on macOS Oct 9, 2018
build fix: allow renaming electron.exe (#15173) Oct 16, 2018
buildflags refactor: move color_chooser out of chromium_src (#15091) Oct 11, 2018
chromium_src chore: remove ColorChooser file that's no longer used (#15186) Oct 16, 2018
components/pepper_flash fix: linking pepper flash on Linux Oct 9, 2018
default_app fix default_app.js calling no-longer-existent API Oct 9, 2018
docs-translations update references to renamed i18n repo Mar 2, 2018
docs docs: change examples in docs to use for..of and async/await (#15196) Oct 16, 2018
lib add width to webview iframe (#15195) Oct 17, 2018
manifests refactor: move printing out of chromium_src (#15023) Oct 13, 2018
native_mate chore: add GN linting (#14678) Oct 3, 2018
npm chore: update to standard 12 Sep 14, 2018
patches fix: do not enable node integration in child window if not enabled (#… Oct 16, 2018
script chore: add --fix option to lint:cpp (#14977) Oct 16, 2018
spec fix: allow renaming electron.exe (#15173) Oct 16, 2018
tools ci: fix the upload distribution step on VSTS (#15015) Oct 8, 2018
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 ci: migrate libcc's Dockerfile to electron and update it (#14786) Sep 25, 2018
.env.example clarify purpose of .env.example Jul 11, 2018
.eslintrc.json chore(eslint): add extension to .eslintrc file (#15020) Oct 8, 2018
.gitattributes chore: force patches to be checked out with LF line endings (#14789) Sep 25, 2018
.gitignore chore: replace standard with eslint-config-standard and add custom ru… Sep 15, 2018
.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: allow renaming electron.exe (#15173) Oct 16, 2018
CODE_OF_CONDUCT.md Change Contact Emails (#12278) Mar 14, 2018
CONTRIBUTING.md add docs/development/README.md (#12373) Mar 20, 2018
DEPS chore: roll node (#15097) Oct 12, 2018
Dockerfile ci: migrate libcc's Dockerfile to electron and update it (#14786) Sep 25, 2018
Dockerfile.arm32v7 ci: use ubuntu 18.04 for arm testing (#14988) Oct 5, 2018
Dockerfile.arm64v8 ci: Trigger an arm test on VSTS after CircleCI build (#14898) Oct 4, 2018
LICENSE Update license year Dec 31, 2017
README.md docs: Add Electron Fiddle to the readme (#14396) Sep 1, 2018
SECURITY.md Change Contact Emails (#12278) Mar 14, 2018
VERSION Bump v4.0.0-nightly.20181010 Oct 10, 2018
appveyor.yml ci: various fixes (#15004) Oct 7, 2018
electron_paks.gni refactor: create request context from network context (#14656) Oct 4, 2018
electron_resources.grd native_desktop_media_list.h depends on //chrome/app:generated_resources Oct 9, 2018
electron_strings.grdp refactor: move printing out of chromium_src (#15023) Oct 13, 2018
filenames.gni fix: add microtask runner and fix promise test (#15071) Oct 15, 2018
package-lock.json Bump v4.0.0-nightly.20181010 Oct 10, 2018
package.json fix: add microtask runner and fix promise test (#15071) Oct 15, 2018
vsts-arm-test-steps.yml chore: remove --enable-logging, causing issues on CI Oct 10, 2018
vsts-arm32v7.yml ci: use ubuntu 18.04 for arm testing (#14988) Oct 5, 2018
vsts-arm64v8.yml ci: Trigger an arm test on VSTS after CircleCI build (#14898) Oct 4, 2018
vsts.yml fix: natively implement LoginItem functions (#15010) Oct 12, 2018

README.md

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status Join the Electron Community on Slack

📝 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.

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.