No description
Find a file
Mehedi Hassan 1d58db82f2
Fix node.lib download link (#21930)
The documentation is currently pointing to a download link that leads to a 404 for the ARM64 version of `node.lib`. This change updates the link to the correct download for ARM64 `node.lib`.
2020-01-28 22:15:09 +00:00
.circleci ci: use goma for windows and linux builds (#21868) 2020-01-23 09:47:38 -08:00
.github chore: delete the security issue template (#21344) 2019-12-01 15:23:31 -08:00
build chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
buildflags fix: MediaKey globalShortcuts not working on macOS (#21442) 2019-12-11 15:48:55 +09:00
chromium_src fix: [extensions] some chrome.extension APIs (#21804) 2020-01-21 09:44:09 +09:00
default_app feat: add a new contextBridge module (#20307) 2019-10-18 12:57:09 -07:00
docs Fix node.lib download link (#21930) 2020-01-28 22:15:09 +00:00
lib feat: add more options to printToPDF (#21906) 2020-01-28 20:47:24 +00:00
npm fix: npm download failed when define 'npm_config_platform=mas' (#21801) 2020-01-17 14:44:21 +09:00
patches fix: window.print() only working once (#21893) 2020-01-27 18:54:56 +00:00
script ci: Use Windows VM initialized via script (#21882) 2020-01-27 21:45:04 -05:00
shell Bump v9.0.0-nightly.20200128 2020-01-28 07:33:06 -08:00
spec chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
spec-main feat: add more options to printToPDF (#21906) 2020-01-28 20:47:24 +00:00
tools build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
typings refactor: declare KeyWeakMap<K, V> returned by createIDWeakMap() / createDoubleIDWeakMap() (#21171) 2019-11-21 13:32:31 +01: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
.eslintrc.json chore: lint spec-main (#20835) 2019-11-01 13:37:02 -07:00
.gitattributes
.gitignore build: make CI faster, magic contained within (#21086) 2019-11-27 16:29:53 -08:00
.gitmodules
.remarkrc
appveyor.yml ci: Use Windows VM initialized via script (#21882) 2020-01-27 21:45:04 -05:00
azure-pipelines-woa.yml test: there is only --ci (#20794) 2019-10-30 16:38:21 -07:00
BUILD.gn chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md docs: Update Issue Closure in CONTRIBUTING.md (#20545) 2019-10-14 09:40:01 -07:00
DEPS chore: bump chromium to b243c83a66a7fded00f3408107778 (master) (#21827) 2020-01-21 09:39:37 -08:00
electron_paks.gni chore: bump chromium to b243c83a66a7fded00f3408107778 (master) (#21827) 2020-01-21 09:39:37 -08:00
electron_resources.grd
electron_strings.grdp feat: enable builtin spellchecker (#20692) 2019-10-31 13:11:51 -07:00
ELECTRON_VERSION Bump v9.0.0-nightly.20200128 2020-01-28 07:33:06 -08:00
filenames.auto.gni chore: [extensions] support old APIs when enable_electron_extensions = true (#21812) 2020-01-21 09:42:55 -08:00
filenames.gni chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
filenames.hunspell.gni chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
LICENSE chore: update license year (#21657) 2020-01-03 11:10:23 -05:00
package.json Bump v9.0.0-nightly.20200128 2020-01-28 07:33:06 -08:00
README.md docs: update README.md (#20644) 2019-10-21 12:14:42 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
tsconfig.default_app.json
tsconfig.electron.json
tsconfig.json
tsconfig.spec.json
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 chore: upgrade ts generator for better type safety (#20975) 2019-11-05 13:34:04 -08: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.