No description
Find a file
Sofia Nguy ce53c35e1d
docs: update currently supported versions for 9.0.0 release (#23510)
* docs: update currently supported versions for 9.0.0 release

* update supported version numbers back to xy format
2020-05-19 09:22:38 -05:00
.circleci build: use correct v8_context_snapshot_generator in mksnapshot zip (#23536) 2020-05-12 14:52:56 -04:00
.github chore: update PR template to suggest 'none' instead of no-notes (#22864) 2020-03-30 10:13:26 -07:00
build fix: exclude crashpad_handler binary on linux (#23538) 2020-05-13 15:28:12 -07:00
buildflags fix: build when some buildflags are disabled (#23307) 2020-04-28 23:16:10 -07:00
chromium_src fix: crashReporter incompatible with sandbox on Linux (#23265) 2020-05-07 13:31:26 -07:00
default_app build: enable JS semicolons (#22783) 2020-03-20 13:28:31 -07:00
docs docs: update currently supported versions for 9.0.0 release (#23510) 2020-05-19 09:22:38 -05:00
lib refactor: tsify net module (#23618) 2020-05-18 10:22:48 -07:00
npm fix: do not ignore electron exit signals in cli.js wrapper (#22878) 2020-04-13 15:49:01 +09:00
patches fix: make sure hunspell file is not destroyed in UI thread (#23631) 2020-05-19 09:55:23 -04:00
script feat: look harder for a commit's pull request. (#23593) 2020-05-14 18:50:39 -05:00
shell fix: nativeImage remote serialization (#23543) 2020-05-18 09:29:24 -07:00
spec ci: use longer mocha timeout on WOA testing (#23633) 2020-05-18 12:33:54 -04:00
spec-main test: add retries to another beforeunload test (#23644) 2020-05-19 11:06:19 +09:00
tools build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
typings refactor: tsify net module (#23618) 2020-05-18 10:22:48 -07:00
vendor
.clang-format
.dockerignore build: remove scripts in the tools dir that are unused (#18944) 2019-06-22 22:29:22 -07:00
.env.example build: move Windows release builds to AppVeyor cloud (#18337) 2019-05-23 16:54:34 -04:00
.eslintrc.json build: allow use of BUILDFLAG directives from within JS code (#20328) 2020-05-11 01:06:07 +02:00
.gitattributes build: set merge=union for .patches (#22985) 2020-04-06 15:15:35 -07:00
.gitignore build: make CI faster, magic contained within (#21086) 2019-11-27 16:29:53 -08:00
.gitmodules
.remarkrc
appveyor.yml build: save mksnapshot args on Windows (#23634) 2020-05-18 15:42:23 -04:00
azure-pipelines-woa.yml ci: use longer mocha timeout on WOA testing (#23633) 2020-05-18 12:33:54 -04:00
BUILD.gn fix: generate symbols for the correct crashpad handler binary (#23537) 2020-05-13 13:54:40 -07:00
CODE_OF_CONDUCT.md docs: update code of conduct (#23137) 2020-04-20 14:52:58 -04:00
CONTRIBUTING.md docs: Update Issue Closure in CONTRIBUTING.md (#20545) 2019-10-14 09:40:01 -07:00
DEPS chore: bump chromium to 0f4170320ff37e971064916aed1dc (master) (#23285) 2020-04-30 13:20:44 -07:00
electron_paks.gni feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_resources.grd feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_strings.grdp feat: enable builtin spellchecker (#20692) 2019-10-31 13:11:51 -07:00
ELECTRON_VERSION Bump v10.0.0-nightly.20200518 2020-05-18 08:31:53 -07:00
filenames.auto.gni refactor: tsify net module (#23618) 2020-05-18 10:22:48 -07:00
filenames.gni refactor: remove the RenderFrameFunctionStore and use privates to memory manage (#23592) 2020-05-15 11:57:40 -07:00
filenames.hunspell.gni chore: bump chromium to 98ebf6c3f0b7bd96bdb1a4b42208f (master) (#22999) 2020-04-13 16:39:26 -07:00
LICENSE chore: update license year (#21657) 2020-01-03 11:10:23 -05:00
package.json Bump v10.0.0-nightly.20200518 2020-05-18 08:31:53 -07:00
README.md docs: update README.md (#20644) 2019-10-21 12:14:42 -07:00
SECURITY.md
tsconfig.default_app.json chore: fix ts config to not complain about extraneous files (#16790) 2019-02-06 15:46:10 -08:00
tsconfig.electron.json chore: fix ts config to not complain about extraneous files (#16790) 2019-02-06 15:46:10 -08:00
tsconfig.json chore: convert more files to TypeScript (#18820) 2019-07-17 10:23:52 -07:00
tsconfig.spec.json spec: initial spike of main-process based tests 2019-03-14 12:50:06 -07:00
vsts-arm-test-steps.yml ci: fix crash on arm testing (#21407) 2019-12-05 14:44:02 -08:00
vsts-arm32v7.yml build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
vsts-arm64v8.yml build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
yarn.lock test: refactor crashReporter tests (#23178) 2020-04-22 15:53:12 -07:00

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status

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

Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

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.