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: run nightly builds for Chromium upgrade branches Sep 21, 2018
.github chore: ask for specific info in bug templates (#14229) Aug 22, 2018
.vsts refactor: use one script to launch all linters (#14622) Sep 17, 2018
atom refactor: clean up the default app implementation (#14719) Sep 21, 2018
brightray chore: run clang-format Sep 19, 2018
build build: with enable_extensions=false (#14657) Sep 18, 2018
chromium_src chore: run clang-format Sep 19, 2018
components/pepper_flash Rename buildflag_headers for consistency Sep 11, 2018
default_app refactor: clean up the default app implementation (#14719) Sep 21, 2018
docs-translations update references to renamed i18n repo Mar 2, 2018
docs Fix second-instance handler signature (#14731) Sep 21, 2018
lib chore: have 'use strict' consistently across our lib files (#14721) Sep 22, 2018
native_mate [wip] build: try building node with GN Aug 10, 2018
npm chore: update to standard 12 Sep 14, 2018
patches chore: move crashpad patch to chromium dir (#14744) Sep 21, 2018
script test: inherit stdio when 'npm install'ing spec deps (#14740) Sep 20, 2018
spec test: reenable app moduele > app.exit(exitCode) > closes all windows Sep 20, 2018
tools chore: update to standard 12 Sep 14, 2018
vendor chore: remove vendored depot_tools (#14676) Sep 19, 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
.eslintrc chore: replace standard with eslint-config-standard and add custom ru… Sep 15, 2018
.gitignore chore: replace standard with eslint-config-standard and add custom ru… Sep 15, 2018
.gitmodules chore: remove vendored depot_tools (#14676) Sep 19, 2018
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. Nov 20, 2017
BUILD.gn chore: add ffmpeg dist zip (#14681) Sep 20, 2018
CODE_OF_CONDUCT.md Change Contact Emails (#12278) Mar 14, 2018
CONTRIBUTING.md add docs/development/README.md (#12373) Mar 20, 2018
DEPS build: move libcc patches to electron repo (#14104) Sep 14, 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 docs: Add Electron Fiddle to the readme (#14396) Sep 1, 2018
SECURITY.md Change Contact Emails (#12278) Mar 14, 2018
appveyor.yml ci: fix CI runs after 9e85bdb Sep 14, 2018
electron.gyp build: remove gyp build files (#14097) Sep 9, 2018
electron_paks.gni build: remove duplicate devtools sources (#14522) Sep 12, 2018
filenames.gni refactor: clean up the default app implementation (#14719) Sep 21, 2018
package-lock.json docs: type the promises in our docs (#14715) Sep 20, 2018
package.json refactor: clean up the default app implementation (#14719) Sep 21, 2018
vsts.yml ci:Make sure that tests on VSTS get marked as failed if they fail (#1… Sep 20, 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.