C++ JavaScript Objective-C++ Python Objective-C HTML Other
Latest commit 306b627 Oct 18, 2017 @zeke zeke Merge pull request #10839 from qazbnm456/update_docs
[docs] update app.md
Permalink
Failed to load latest commit information.
.circleci Bump to use large machine for arm64 build Sep 28, 2017
.github updates to probot config Sep 29, 2017
atom v1.8.2-beta.1 Oct 18, 2017
brightray Merge pull request #10709 from electron/fix-notification-actions-hs Oct 17, 2017
chromium_src Create watcher when message loop is ready Sep 20, 2017
default_app remove potential deprecation and fix app close Oct 7, 2017
docs-translations Merge pull request #10740 from demopark/patch-1 Oct 17, 2017
docs according to #10670, update app.md Oct 18, 2017
lib πŸ”§ String comparison Oct 7, 2017
npm Update install.js Oct 11, 2017
script v1.8.2-beta.1 Oct 18, 2017
spec add error code to session.setCertificateVerifyProc Oct 16, 2017
tools Use real shared library names for symbol files Oct 16, 2017
vendor Revert official build Oct 11, 2017
.clang-format Add clang-format config file. Oct 4, 2016
.dockerignore Add xvfb-init.sh to docker context Aug 15, 2017
.gitignore Change GitHub upload to use JS GitHub lib Sep 23, 2017
.gitmodules Move brightray submodules to root vendor May 10, 2017
.node-version Bump node version number Sep 14, 2017
.travis.yml Add arm64 task in travis ci Aug 22, 2017
CODE_OF_CONDUCT.md πŸ“ Update to v1.4 of the Code of Conduct May 5, 2016
CONTRIBUTING.md add issue maintenance and closure information Sep 29, 2017
Dockerfile Fix CI for Linux Aug 29, 2017
Dockerfile.circleci Add CircleCI for Linux builds (#10344) Sep 13, 2017
LICENSE Update copyright year in LICENSE file Jan 3, 2017
README.md restore links to translated READMEs Aug 8, 2017
SECURITY.md Add SECURITY.md Jan 30, 2017
appveyor.yml Fix typo Jul 11, 2017
common.gypi Upgrade to node 8.2.0 Aug 15, 2017
electron.gyp v1.8.2-beta.1 Oct 18, 2017
features.gypi Add enable_osr build flag Jun 28, 2017
filenames.gypi Implement moveToApplicationsFolder (#10142) Aug 31, 2017
package.json v1.8.2-beta.1 Oct 18, 2017
toolchain.gypi Add arm64 build support Aug 22, 2017

README.md

Electron Logo

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

πŸ“ Available Translations: Korean | Simplified Chinese | Brazilian Portuguese | Traditional Chinese | Spanish | Turkish | German

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 electron@github.com.

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 as Electron does not follow semantic versioning. 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

Community

You can ask questions and interact with the community in the following locations:

Check out awesome-electron for a community maintained list of useful example apps, tools and resources.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.