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 build: fix linux release builds on CircleCI (#18201) May 8, 2019
.github chore: update codeowners for release scripts (#18246) May 16, 2019
atom refactor: address TODO for WebContents type parsing (#18158) May 20, 2019
build build: ensure consistent lock files across multiple machines (#17955) Apr 30, 2019
buildflags fix: port OSR code to new viz compositor codepath (#17538) Apr 17, 2019
chromium_src chore: convert more files away from base::Bind (#18121) May 3, 2019
components/pepper_flash chore: fix linking errors on Windows Feb 14, 2019
default_app fix: correctly parse default_app path on windows (#18086) May 1, 2019
docs-translations update references to renamed i18n repo Mar 2, 2018
docs docs: link to better list of icons for nativeImage.createFromNamedIma… May 18, 2019
lib refactor: address TODO for WebContents type parsing (#18158) May 20, 2019
native_mate chore: add native_mate to lint:cpp (#18100) May 2, 2019
npm feat: add env variable to skip binary download on npm install (#17627) May 3, 2019
patches chore: Add patch to partially revert chromium crashpad change (#17978) May 10, 2019
script build: remove deprecated octokit auth calls (#18205) May 8, 2019
spec-main build: move to the new docs parser (#18103) May 6, 2019
spec feat: add webContents 'zoom-changed' event (#17747) May 14, 2019
tools refactor: remove js2asar.py and port logic to JS in more readable / G… Feb 5, 2019
typings build: move to the new docs parser (#18103) May 6, 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 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 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 chore: bump chromium to 7dff37844cb3 (master) (#18059) May 1, 2019
CODE_OF_CONDUCT.md Change Contact Emails (#12278) Mar 14, 2018
CONTRIBUTING.md add docs/development/README.md (#12373) Mar 20, 2018
DEPS refactor: allow embedder overriding of internal FS calls (#17906) (#1… May 7, 2019
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
ELECTRON_VERSION Bump v6.0.0-nightly.20190404 Apr 4, 2019
LICENSE fix: update license year (#16287) Jan 5, 2019
README.md docs: add information about contributing (#17961) Apr 26, 2019
SECURITY.md Change Contact Emails (#12278) Mar 14, 2018
appveyor.yml build: notify MC of failures to allow easy reruns (#17981) Apr 26, 2019
electron_paks.gni feat: Upgrade to Chromium 71.0.3578.98 (#15966) Jan 12, 2019
electron_resources.grd chore: use c++ manifests instead of json Feb 14, 2019
electron_strings.grdp refactor: printing implementation (#15143) Nov 9, 2018
filenames.auto.gni build: move to the new docs parser (#18103) May 6, 2019
filenames.gni feat: migrate protocol module to NetworkService (Part 7) (#18290) May 14, 2019
package.json build: move to the new docs parser (#18103) May 6, 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 build: Update TypeScript, use @typescript-eslint (#17251) Mar 7, 2019
tsconfig.spec.json spec: initial spike of main-process based tests Mar 14, 2019
vsts-arm-test-steps.yml build: remove native mksnapshot for arm/arm64 (#17561) Mar 28, 2019
vsts-arm32v7.yml ci: use ubuntu 18.04 for arm testing (#14988) Oct 5, 2018
vsts-arm64v8.yml build: make torque patch more specific for native arm builds (#16992) Feb 18, 2019
yarn.lock build: move to the new docs parser (#18103) May 6, 2019

README.md

Electron Logo

CircleCI Build Status AppVeyor Build Status Azure Pipelines 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.

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.