No description
Find a file
Charles Kerr bbde795a1f
Merge pull request #10923 from electron/nvidia-high-sierra-fix
Fix rendering issues with Nvidia GPU on High Sierra
2017-11-13 18:00:38 -06:00
.circleci Generate API and typescript file as artifact on CircleCI to make verifying changes easier 2017-11-08 16:55:24 +13:00
.github updates to probot config 2017-09-29 13:28:49 -04:00
atom No need to add new methods to WebContentsPreferences 2017-11-13 17:35:49 +09:00
brightray fix devtools again 2017-11-13 15:50:49 +09:00
chromium_src Create watcher when message loop is ready 2017-09-20 11:58:32 +09:00
default_app 🔧 Bring back —abi 2017-11-10 14:58:21 -08:00
docs Merge pull request #11056 from ajmacd/allow-browser-window-logs 2017-11-11 14:34:39 +11:00
docs-translations remove deprecated docs translations 2017-11-06 15:48:47 -08:00
lib lint fix 2017-11-13 15:46:46 +09:00
npm revert electron-download dependency to ^3.0.1 2017-11-03 09:45:09 -05:00
script v1.8.2-beta.2 2017-11-06 16:11:34 -05:00
spec Merge pull request #11056 from ajmacd/allow-browser-window-logs 2017-11-11 14:34:39 +11:00
tools Use real shared library names for symbol files 2017-10-16 16:48:52 +02:00
vendor Merge pull request #10923 from electron/nvidia-high-sierra-fix 2017-11-13 18:00:38 -06:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore Add xvfb-init.sh to docker context 2017-08-15 16:19:22 +03:00
.gitignore Change GitHub upload to use JS GitHub lib 2017-09-24 06:26:04 +09:00
.gitmodules Move brightray submodules to root vendor 2017-05-10 13:27:22 -07:00
.node-version Bump node version number 2017-09-15 00:58:31 +02:00
.travis.yml Add arm64 task in travis ci 2017-08-22 10:02:51 +09:00
appveyor.yml Fix typo 2017-07-11 10:55:59 +08:00
CODE_OF_CONDUCT.md
common.gypi Upgrade to node 8.2.0 2017-08-15 16:19:23 +03:00
CONTRIBUTING.md clean up remaining references to docs-translations content 2017-11-08 19:06:18 -08:00
Dockerfile Fix CI for Linux 2017-08-29 14:19:20 +09:00
Dockerfile.circleci Add CircleCI for Linux builds (#10344) 2017-09-13 09:48:19 -04:00
electron.gyp v1.8.2-beta.2 2017-11-06 16:11:34 -05:00
features.gypi Add enable_osr build flag 2017-06-28 18:58:52 +02:00
filenames.gypi Implement moveToApplicationsFolder (#10142) 2017-08-31 10:37:12 -04:00
Jenkinsfile Add Jenkinsfile to enable rebuilds 2017-11-07 16:32:09 -05:00
LICENSE Update copyright year in LICENSE file 2017-01-02 21:19:38 -08:00
package.json clean up remaining references to docs-translations content 2017-11-08 19:06:18 -08:00
README.md Update README.md 2017-11-10 18:26:07 +09:00
SECURITY.md Add SECURITY.md 2017-01-30 10:49:17 -08:00
toolchain.gypi Add arm64 build support 2017-08-22 10:02:51 +09:00

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 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

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.