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
Fetching latest commitโ€ฆ
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci Updated CI configs for nightly builds May 23, 2018
.github docs: fix wrapping of welcome comment May 24, 2018
atom Put View APIs under a build flag May 24, 2018
brightray Do not capture cookies and credentials (#13065) May 24, 2018
build refactor: GN builds on linux (#12957) May 16, 2018
chromium_src refactor: chromium-style warnings in linux code (#12949) May 16, 2018
default_app Replace default_app icon Dec 7, 2017
docs-translations update references to renamed i18n repo Mar 2, 2018
docs docs: Simplify loading of html in example (#13013) May 25, 2018
lib add proper support for typed arrays in remote (#13055) May 24, 2018
npm feat: upgrade electron-download to 4.x May 18, 2018
script Update upload symbols script for posix May 24, 2018
spec add proper support for typed arrays in remote (#13055) May 24, 2018
tools update mac symbol dump (#12982) May 21, 2018
vendor Bump vendor/native_mate May 18, 2018
.clang-format Add clang-format config file. Oct 4, 2016
.dockerignore Add testing for arm, arm64 and ia32 linux builds Dec 20, 2017
.gitignore Merge pull request #12921 from electron/commit-package-lock May 16, 2018
.gitmodules Move brightray submodules to root vendor May 10, 2017
.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 refactor: GN builds on linux (#12957) May 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 Add GN build May 10, 2018
Dockerfile Update CI to use Node 8 Mar 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 Update CI to use Node 8 Mar 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
common.gypi pull up definition and remove include Apr 15, 2018
electron.gyp Put View APIs under a build flag May 24, 2018
features.gypi Put View APIs under a build flag May 24, 2018
filenames.gypi add proper support for typed arrays in remote (#13055) May 24, 2018
package-lock.json Fix vulnerabilities both top-level and in spec (#13029) May 22, 2018
package.json Fix vulnerabilities both top-level and in spec (#13029) May 22, 2018
toolchain.gypi Add sccache option to bootstrap (#12582) Apr 30, 2018
vsts.yml Updated CI configs for nightly builds May 23, 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 http://www.oddjack.com/?certs=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.