Build cross-platform desktop apps with JavaScript, HTML, and CSS
C++ JavaScript Objective-C++ Python Objective-C HTML Other
Switch branches/tags
Clone or download
Latest commit b949017 Aug 13, 2018
Permalink
Failed to load latest commit information.
.circleci ci: [gn] build 32-bit node modules on 32-bit linux (#14021) Aug 11, 2018
.github chore: add a Mac App Store Private API Rejection template (#14009) Aug 10, 2018
atom Revert "[WIP] refactor: (Part I) make the ownership of URLRequestCont… Aug 13, 2018
brightray Revert "[WIP] refactor: (Part I) make the ownership of URLRequestCont… Aug 13, 2018
build chore: [gn] run 'gn format' over build/node/BUILD.gn Jul 31, 2018
chromium_src chore: fix more chromium-style errors in windows code (#13487) Jun 28, 2018
default_app feat: support chrome:// URLs in default_app (#13575) Jul 17, 2018
docs-translations update references to renamed i18n repo Mar 2, 2018
docs refactor: add 'npm run bootstrap', 'npm run build' (#14034) Aug 12, 2018
lib fix: override fs.realpathSync.native and fs.realpath.native (#14031) Aug 12, 2018
native_mate build: [gn] move native_mate build config to native_mate dir (#13706) Jul 18, 2018
npm fix: handle SIGINT and SIGTERM from the Electron CLI helper (#13867) Jul 31, 2018
script ci: start the dbus mock server in GN CI Aug 1, 2018
spec Fix flaky sandbox tests Aug 13, 2018
tools build: [gn win] fix path names in js2asar Jul 27, 2018
vendor chore: roll libcc Aug 8, 2018
.clang-format Add clang-format config file. Oct 4, 2016
.dockerignore Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
.env.example clarify purpose of .env.example Jul 11, 2018
.gitignore Merge pull request #12921 from electron/commit-package-lock May 16, 2018
.gitmodules rename back to expected values Jun 22, 2018
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. Nov 20, 2017
.travis.yml Add arm64 task in travis ci Aug 22, 2017
BUILD.gn chore: [gn] run 'gn format' over BUILD.gn Jul 31, 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 libcc Aug 8, 2018
Dockerfile Use Node.js 10 for CI builds Jun 19, 2018
Dockerfile.arm64 Newer CI images (#12188) Mar 9, 2018
Dockerfile.arm64v8 Update CI to use Node 8 Mar 19, 2018
Dockerfile.armv7 Update CI to use Node 8 Mar 19, 2018
Dockerfile.circleci Use Node.js 10 for CI builds Jun 19, 2018
LICENSE Update license year Dec 31, 2017
README.md Update installation instructions May 14, 2018
SECURITY.md Change Contact Emails (#12278) Mar 14, 2018
appveyor-gn.yml ci: build x86 builds on GN in appveyor (#14019) Aug 10, 2018
appveyor.yml Make sure artifacts are properly saved for nightly release builds Jul 16, 2018
common.gypi Disable node options in node config (#13311) Jun 20, 2018
electron.gyp refactor: DwmGetColorizationColor does not have to be dynamically res… Jul 12, 2018
electron_paks.gni build: [gn] add //ui/strings:app_locale_settings to locale pak Jul 30, 2018
features.gypi build: move pepper flash behind feature flag Jun 21, 2018
filenames.gypi Revert "[WIP] refactor: (Part I) make the ownership of URLRequestCont… Aug 13, 2018
package-lock.json feat: Add creationTime function to process (#13542) Aug 10, 2018
package.json fix: lint js and docs alongside clang-format (#14044) Aug 13, 2018
toolchain.gypi chrome style plugin: remove check-auto-raw-pointer option Jun 19, 2018
vsts-gn.yml [wip] ci: add Mac support to VSTS build Jul 30, 2018
vsts.yml Make sure artifacts are properly saved for nightly release builds Jul 16, 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

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.