No description
Find a file
Jeremy Apthorp 041c952574 fix: enable spell checking, which broke in upgrade to ch66
Chromium commit [03563dd163][1] changed the way that the
spellcheck-enabled status was checked, defaulting to false.

Added the first (!) test for spellchecking, too.

Fixes #13608.

[1]: 03563dd163
2018-07-12 13:28:15 -07:00
.circleci Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
.github docs: update pr template with checklist (#13270) 2018-06-18 13:58:30 -07:00
atom fix: enable spell checking, which broke in upgrade to ch66 2018-07-12 13:28:15 -07:00
brightray Backport (3-0-x) - Fix devtools not functioning well (#13571) 2018-07-06 13:19:21 +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 Replace default_app icon 2017-12-07 16:10:45 -05:00
docs Update docs to reflect current process 2018-07-12 12:56:02 +00:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib fix double-freeing remote references 2018-07-12 11:17:26 +09:00
native_mate Revert "Native mate in electron 3 (#13450)" (#13455) 2018-06-27 17:43:01 +10:00
npm feat: upgrade electron-download to 4.x 2018-05-17 23:16:27 -07:00
script Fix Appveyor URL 2018-07-12 12:56:02 +00:00
spec fix: enable spell checking, which broke in upgrade to ch66 2018-07-12 13:28:15 -07:00
tools update mac symbol dump (#12982) 2018-05-21 10:01:17 +09:00
vendor Merge pull request #13591 from trop-bot/3-0-x-bp-fix-failed-devtools-tests-due-to-fs.statsyncnoexception-not-working--1531147212282 2018-07-09 14:30:42 -04:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.gitignore Merge pull request #12921 from electron/commit-package-lock 2018-05-16 11:47:21 -04:00
.gitmodules Revert "Native mate in electron 3 (#13450)" (#13455) 2018-06-27 17:43:01 +10: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
appveyor.yml Skip tests for release build 2018-06-20 18:20:04 -04: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.2 2018-07-10 14:12:05 -04: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 Update license year 2018-01-01 00:51:40 +01:00
package-lock.json Fix vulnerabilities both top-level and in spec (#13029) 2018-05-21 21:15:18 -07:00
package.json Bump v3.0.0-beta.2 2018-07-10 14:12:05 -04: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 Fix VSTS config for release builds 2018-06-19 10:19:51 -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

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.