No description
Find a file
2018-10-19 23:56:40 +11:00
.circleci ci: Fix timeout when generating breakpad symbols (#15126) 2018-10-13 13:02:52 +11:00
.github chore: update pr template for no-notes (#15137) 2018-10-12 19:24:19 -07:00
.vsts chore: add GN linting (#14678) 2018-10-03 18:03:26 -05:00
atom refactor: remove WebContents::CreateFrom (#15241) 2018-10-19 17:52:07 +09:00
brightray refactor: move notifications from brightray to atom (#15209) 2018-10-17 20:01:11 +02:00
build fix: allow renaming electron.exe (#15173) 2018-10-15 17:26:34 -07:00
buildflags refactor: move color_chooser out of chromium_src (#15091) 2018-10-12 10:53:46 +11:00
chromium_src chore: remove ColorChooser file that's no longer used (#15186) 2018-10-16 13:49:57 +11:00
components/pepper_flash fix: linking pepper flash on Linux 2018-10-09 14:38:00 -07:00
default_app fix default_app.js calling no-longer-existent API 2018-10-09 14:38:00 -07:00
docs feat: expose setBackgroundThrottling api (#15104) 2018-10-19 11:32:22 +11:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib feat: expose setBackgroundThrottling api (#15104) 2018-10-19 11:32:22 +11:00
manifests refactor: move printing out of chromium_src (#15023) 2018-10-13 12:57:04 +11:00
native_mate chore: add GN linting (#14678) 2018-10-03 18:03:26 -05:00
npm chore: update to standard 12 2018-09-14 14:57:01 +10:00
patches chore: don't set allow_new_privs in new processes (#15229) 2018-10-18 11:53:26 -07:00
script chore: make macOS release builds higher priority to skip the queue (#15276) 2018-10-19 23:56:40 +11:00
spec test: asyncawaitify one of sandbox related tests (#15252) 2018-10-19 14:28:23 +11:00
tools ci: fix the upload distribution step on VSTS (#15015) 2018-10-08 15:19:40 -05:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore ci: migrate libcc's Dockerfile to electron and update it (#14786) 2018-09-25 15:30:22 -04:00
.env.example clarify purpose of .env.example 2018-07-11 12:55:15 -07:00
.eslintrc.json chore(eslint): add extension to .eslintrc file (#15020) 2018-10-08 14:21:34 -05:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore chore: replace standard with eslint-config-standard and add custom rules (#14636) 2018-09-16 03:51:23 +10:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml ci: various fixes (#15004) 2018-10-07 16:05:20 +02:00
BUILD.gn fix: allow renaming electron.exe (#15173) 2018-10-15 17:26:34 -07:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
DEPS fix: enable NODE_OPTIONS env var (#15158) 2018-10-19 10:57:28 +11:00
Dockerfile ci: migrate libcc's Dockerfile to electron and update it (#14786) 2018-09-25 15:30:22 -04:00
Dockerfile.arm32v7 ci: use ubuntu 18.04 for arm testing (#14988) 2018-10-05 09:29:32 -05:00
Dockerfile.arm64v8 ci: Trigger an arm test on VSTS after CircleCI build (#14898) 2018-10-04 12:01:16 -04:00
electron_paks.gni refactor: create request context from network context (#14656) 2018-10-04 13:08:56 -05:00
electron_resources.grd native_desktop_media_list.h depends on //chrome/app:generated_resources 2018-10-09 14:38:00 -07:00
electron_strings.grdp refactor: move printing out of chromium_src (#15023) 2018-10-13 12:57:04 +11:00
filenames.gni feat: add remote.require() / remote.getGlobal() filtering (#15014) 2018-10-18 14:36:45 +11:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package-lock.json feat: Spellchecker Async Implementation (#14032) 2018-10-18 11:11:53 -05:00
package.json feat: Spellchecker Async Implementation (#14032) 2018-10-18 11:11:53 -05:00
README.md docs: Add Electron Fiddle to the readme (#14396) 2018-08-31 22:56:55 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
VERSION Bump v4.0.0-nightly.20181010 2018-10-10 06:38:01 -07:00
vsts-arm-test-steps.yml chore: remove --enable-logging, causing issues on CI 2018-10-10 12:11:16 +11:00
vsts-arm32v7.yml ci: use ubuntu 18.04 for arm testing (#14988) 2018-10-05 09:29:32 -05:00
vsts-arm64v8.yml ci: Trigger an arm test on VSTS after CircleCI build (#14898) 2018-10-04 12:01:16 -04:00
vsts.yml ci: make sure git directories don't have unneeded files in them (#15247) 2018-10-18 11:35:40 -04: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 & Electron Fiddle

Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and to try out different versions of Electron. It's designed to make the start of your journey with Electron easier.

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