No description
Find a file
Cheng Zhao 277f93653e
feat: migrate protocol module to NetworkService (Part 3) (#18030)
* Implement http protocol handler

* File protocol handler also accepts options

* Http protocol should inherit headers by default

* Only inherit necessary headers

* Slightly reorder logics
2019-04-30 09:47:04 +09:00
.circleci build: optimize the happy path when syncing on CI (#17827) 2019-04-22 15:36:59 -07:00
.github chore: disable release notes GH Action (#18039) 2019-04-29 13:03:59 -07:00
atom feat: migrate protocol module to NetworkService (Part 3) (#18030) 2019-04-30 09:47:04 +09:00
build feat: upgrade to Node 12 (#17838) 2019-04-26 18:55:12 +09:00
buildflags fix: port OSR code to new viz compositor codepath (#17538) 2019-04-17 14:10:04 -07:00
chromium_src build: enable gn check for //electron:electron_lib (#17100) 2019-03-05 10:38:55 +05:30
components/pepper_flash chore: fix linking errors on Windows 2019-02-14 23:59:26 +05:30
default_app fix: permission handler regression in default app (#17927) 2019-04-24 09:54:53 -07:00
docs refactor: allow requiring modules with no side effects (#17496) 2019-04-30 09:46:08 +09:00
docs-translations
lib refactor: allow requiring modules with no side effects (#17496) 2019-04-30 09:46:08 +09:00
native_mate chore: support converting OnceCallback to V8 (#17941) 2019-04-25 09:40:27 +09:00
npm chore: update @types/node dep (#16174) 2018-12-21 12:59:42 -05:00
patches build: add support for Electron trace events (#17920) 2019-04-29 15:28:30 -07:00
script build: actually run import-patches on gclient sync (#17885) 2019-04-23 10:28:26 -07:00
spec feat: upgrade to Node 12 (#17838) 2019-04-26 18:55:12 +09:00
spec-main refactor: allow requiring modules with no side effects (#17496) 2019-04-30 09:46:08 +09:00
tools refactor: remove js2asar.py and port logic to JS in more readable / GN-style way (#16718) 2019-02-05 12:10:15 -08:00
typings fix: handle remote-debugging-port=0 correctly (#17800) 2019-04-16 14:22:51 -04:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.clang-format
.dockerignore ci: migrate libcc's Dockerfile to electron and update it (#14786) 2018-09-25 15:30:22 -04:00
.env.example
.eslintrc.json build: Update TypeScript, use @typescript-eslint (#17251) 2019-03-07 12:56:02 -08:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore build: optimize the happy path when syncing on CI (#17827) 2019-04-22 15:36:59 -07:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc
appveyor.yml build: notify MC of failures to allow easy reruns (#17981) 2019-04-26 12:35:43 -07:00
BUILD.gn chore: bump chromium to 1e9f9a24aa12 (master) (#17880) 2019-04-20 10:20:37 -07:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md
DEPS feat: upgrade to Node 12 (#17838) 2019-04-26 18:55:12 +09: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 feat: Upgrade to Chromium 71.0.3578.98 (#15966) 2019-01-11 17:00:43 -08:00
electron_resources.grd chore: use c++ manifests instead of json 2019-02-14 23:59:26 +05:30
electron_strings.grdp refactor: printing implementation (#15143) 2018-11-09 14:42:34 +11:00
ELECTRON_VERSION Bump v6.0.0-nightly.20190404 2019-04-04 11:42:14 -07:00
filenames.auto.gni chore: rename atom-binding-setup.ts to electron-binding-setup.ts (#17949) 2019-04-29 10:57:32 -04:00
filenames.gni refactor: allow requiring modules with no side effects (#17496) 2019-04-30 09:46:08 +09:00
LICENSE fix: update license year (#16287) 2019-01-05 12:53:20 -08:00
package-lock.json build: update ts generator (#17929) 2019-04-24 09:57:09 -07:00
package.json build: update ts generator (#17929) 2019-04-24 09:57:09 -07:00
README.md docs: add information about contributing (#17961) 2019-04-26 08:12:21 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
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 build: Update TypeScript, use @typescript-eslint (#17251) 2019-03-07 12:56:02 -08: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 build: remove native mksnapshot for arm/arm64 (#17561) 2019-03-28 11:05:43 -04:00
vsts-arm32v7.yml ci: use ubuntu 18.04 for arm testing (#14988) 2018-10-05 09:29:32 -05:00
vsts-arm64v8.yml build: make torque patch more specific for native arm builds (#16992) 2019-02-18 10:02:50 +00:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Azure Pipelines 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.

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.