No description
Find a file
trop[bot] bfbd4a2540 fix: Improve --enable-features/--disable-features handling (#13923)
As it turns out, we can reinitialize the feature list directly after the
user JS script has been executed instead of much later. This allows
modifications to `--enable-features`/`--disable-features` to work with a
greater set of features.
2018-08-03 13:08:27 +10:00
.circleci make sure tests don't run for GitHub releases. (#13701) 2018-07-17 10:57:59 -05:00
.github docs: update pr template with checklist (#13270) 2018-06-18 13:58:30 -07:00
atom fix: Improve --enable-features/--disable-features handling (#13923) 2018-08-03 13:08:27 +10:00
brightray fix: Improve --enable-features/--disable-features handling (#13923) 2018-08-03 13:08:27 +10:00
build refactor: [gn] compile node with boringssl (#13285) 2018-06-19 10:39:43 -05:00
chromium_src mark worker thread taskrunner as WithBaseSyncPrimitives 2018-06-19 11:49:46 +10:00
default_app
docs memo: Update security docs: will-navigate, new-window (#13887) 2018-08-01 13:25:24 +10:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib fix: some APIs modified for ASAR support cannot be util.promisify'ed (#13902) 2018-08-01 16:38:50 +10:00
native_mate rename back to expected values 2018-06-27 10:05:15 +10:00
npm fix: handle SIGINT and SIGTERM from the Electron CLI helper (#13889) 2018-08-01 13:25:04 +10:00
script fix: update for node 10 2018-07-20 15:23:49 +00:00
spec fix: some APIs modified for ASAR support cannot be util.promisify'ed (#13902) 2018-08-01 16:38:50 +10:00
tools update mac symbol dump (#12982) 2018-05-21 10:01:17 +09:00
vendor build: Bump libcc to latest (3.0.x) (#13822) 2018-07-26 08:25:28 -07:00
.clang-format
.dockerignore
.gitignore prepare for merging to electron 2018-06-22 11:29:57 +10:00
.gitmodules rename back to expected values 2018-06-27 10:05:15 +10:00
.remarkrc
.travis.yml prepare for merging to electron 2018-06-22 11:29:57 +10:00
appveyor.yml make sure tests don't run for GitHub releases. (#13701) 2018-07-17 10:57:59 -05:00
BUILD.gn chore: [gn] add desktop capturer sources to GN build (#13286) 2018-06-19 10:29:36 -05:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
common.gypi Disable node options in node config (#13323) 2018-06-20 17:10:37 +10:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
DEPS Roll libchromiumcontent (#13105) 2018-05-29 13:07:14 -07:00
Dockerfile Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
Dockerfile.arm64 Newer CI images (#12188) 2018-03-08 22:07:50 -05:00
Dockerfile.arm64v8 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.armv7 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.circleci Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
electron.gyp Bump v3.0.0-beta.4 2018-08-01 15:13:06 -05:00
features.gypi re-enable desktop capturer 2018-06-19 11:49:46 +10:00
filenames.gypi Create network_converter for services/network/* types 2018-06-19 11:49:42 +10:00
LICENSE prepare for merging to electron 2018-06-22 11:29:57 +10:00
package-lock.json Bump v3.0.0-beta.4 2018-08-01 15:13:06 -05:00
package.json Bump v3.0.0-beta.4 2018-08-01 15:13:06 -05:00
README.md Update installation instructions 2018-05-14 14:06:22 +03:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
toolchain.gypi chrome style plugin: remove check-auto-raw-pointer option 2018-06-19 11:49:43 +10:00
vsts.yml make sure tests don't run for GitHub releases. (#13701) 2018-07-17 10:57:59 -05:00

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

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.