No description
Find a file
Cheng Zhao e73326a324
Merge pull request #11613 from electron/safe-dialogs
Implement dialog (alert/confirm) blocking as a user switch after the first dialog
2018-03-06 14:28:53 +09:00
.circleci Set DISPLAY variable for xvfb 2018-01-17 12:57:42 -05:00
.github add typing cat to first PR comment (#11964) 2018-02-19 17:45:14 -06:00
atom Make OnMessageBoxCallback a method since it is accessing members 2018-03-06 11:35:53 +09:00
brightray Fix network delegate race condition (#12044) 2018-02-26 06:23:59 -08:00
chromium_src Remove chrome_utility_messages.h, it's unused 2018-02-23 10:21:23 +09:00
default_app Replace default_app icon 2017-12-07 16:10:45 -05:00
docs docs: Default message is not localized 2018-03-06 11:24:42 +09:00
docs-translations Merge https://github.com/kstar0714/electron 2017-11-22 00:45:03 -08:00
lib Implement dialog (alert/confirm) blocking as a user switch after the first dialog 2018-03-06 11:19:15 +09:00
npm revert electron-download dependency to ^3.0.1 2017-11-03 09:45:09 -05:00
script Add optional verbose switch '-v' to build script. (#12118) 2018-03-06 03:27:58 +09:00
spec Native confirm/alert throws differently 2018-03-06 14:06:29 +09:00
tools Remove needless quotes around electron key 2018-02-22 13:37:53 +11:00
vendor Update libcc to latest chrome62 2018-02-23 10:23:53 +09:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.gitignore Update sysroot to Debian Stretch 2018-02-23 10:21:24 +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
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
.travis.yml Add arm64 task in travis ci 2017-08-22 10:02:51 +09:00
CODE_OF_CONDUCT.md fix word CODE_OF_CONDUCT.md 2017-11-21 17:15:14 -08:00
common.gypi Fix error when cross compilation 2018-02-23 10:22:00 +09:00
CONTRIBUTING.md enhance documentation around contributing to electron (#11887) 2018-02-12 08:09:38 -06:00
Dockerfile Enable testing with python-dbusmock 2017-12-05 15:01:01 -05:00
Dockerfile.arm64 replace gtk2 with gtk3 in dockerfiles 2018-02-15 15:03:14 -06:00
Dockerfile.armv7 replace gtk2 with gtk3 in dockerfiles 2018-02-15 15:03:14 -06:00
Dockerfile.circleci Enable testing with python-dbusmock 2017-12-05 15:01:01 -05:00
electron.gyp Use version 0.0.0-dev everywhere 2018-03-05 16:24:48 +01:00
features.gypi Make run-as-node mode optional (#11701) 2018-01-23 18:17:15 -05:00
filenames.gypi Remove chrome_utility_messages.h, it's unused 2018-02-23 10:21:23 +09:00
Jenkinsfile Add 1 hour timeout 2017-12-04 13:19:51 -05:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package.json Merge pull request #11937 from electron/groundwater-patch-1 2018-02-21 16:54:25 -05:00
README.md Fix 'electron-versioning' link in README.md 2017-12-13 22:18:00 +09:00
SECURITY.md 📝 Link to security tutorial 2018-01-28 16:54:58 -08:00
toolchain.gypi Fix error when cross compilation 2018-02-23 10:22:00 +09:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Jenkins Build Status devDependency Status Join the Electron Community on Slack

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹. View these docs in other languages at electron/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 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

Find documentation translations in electron/electron-i18n.

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.