No description
Find a file
Felix Rieseberg 334ea36f38 docs: Add recent Electron version to security checklist (#20206)
* docs: Add recent Electron version to security checklist

* Update docs/tutorial/security.md

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/security.md

Co-Authored-By: Pedro Pontes <pepontes@microsoft.com>

* Update docs/tutorial/security.md

Co-Authored-By: Mark Lee <malept@users.noreply.github.com>
2019-09-13 21:12:14 -04:00
.circleci build: use a lower process count for publish builds with no sccache (#19913) 2019-08-23 14:01:12 -07:00
.github chore: remove unused config files (#19997) 2019-08-28 09:18:49 -07:00
build refactor: unify module-list format and exports/electron (#19697) 2019-08-23 11:18:58 +02:00
buildflags feat: enable picture-in-picture mode for video tags (#17686) 2019-08-22 19:17:50 +09:00
chromium_src feat: HTTP preconnect feature minimal for electronjs (#18671) 2019-08-26 09:47:32 -07:00
components/pepper_flash chore: fix linking errors on Windows 2019-02-14 23:59:26 +05:30
default_app fix: app.getAppPath() returning default-app path for files or directories without package.json (#18763) 2019-06-19 23:34:22 +02:00
docs docs: Add recent Electron version to security checklist (#20206) 2019-09-13 21:12:14 -04:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib refactor: implement isRemoteModuleEnabled via getLastWebPreferences() (#19220) 2019-08-28 15:57:03 -07:00
native_mate chore: remove native_mate (Part 4) (#20146) 2019-09-09 00:10:18 +09:00
npm feat: add openbsd support in the node module (#19860) 2019-08-22 12:09:15 -07:00
patches chore: remove native_mate (Part 4) (#20146) 2019-09-09 00:10:18 +09:00
script build: handle arm64 node headers (#20192) 2019-09-10 14:14:58 -07:00
shell Bump v8.0.0-nightly.20190913 2019-09-13 08:31:01 -07:00
spec fix: resolve crash loading file based serviceworkers (#20132) 2019-09-06 10:01:22 +09:00
spec-main fix: crash when exiting simple fullscreen on macOS (#20144) 2019-09-12 13:38:16 -04:00
tools chore: update to Node.js v12.4.0 (#18924) 2019-07-15 18:58:39 -07:00
typings test: tsify deprecate spec (#20089) 2019-09-04 11:13:37 -07:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.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: ensure consistent lock files across multiple machines (#17955) 2019-04-30 13:59:47 -07:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore build: ensure consistent lock files across multiple machines (#17955) 2019-04-30 13:59:47 -07:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc
appveyor.yml ci: run tests on WOA hardware (#20031) 2019-09-03 13:13:06 -04:00
azure-pipelines-woa.yml ci: run tests on WOA hardware (#20031) 2019-09-03 13:13:06 -04:00
BUILD.gn feat: HTTP preconnect feature minimal for electronjs (#18671) 2019-08-26 09:47:32 -07:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md Update CONTRIBUTING.md 2019-06-19 15:52:11 -07:00
DEPS chore: bump node in DEPS to v12.9.1 (#19980) 2019-08-27 07:51:28 -07:00
Dockerfile chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) 2019-07-02 18:22:09 -07:00
Dockerfile.arm32v7 build: remove GConf and dconf dependencies on linux (#19498) 2019-07-29 08:33:47 -04:00
Dockerfile.arm64v8 build: remove GConf and dconf dependencies on linux (#19498) 2019-07-29 08:33:47 -04:00
electron_paks.gni chore: bump chromium to 2a7aff41ce73adc0eeee67d364989 (master) (#18505) 2019-06-03 20:44:12 -07:00
electron_resources.grd chore: use c++ manifests instead of json 2019-02-14 23:59:26 +05:30
electron_strings.grdp feat: enable picture-in-picture mode for video tags (#17686) 2019-08-22 19:17:50 +09:00
ELECTRON_VERSION Bump v8.0.0-nightly.20190913 2019-09-13 08:31:01 -07:00
filenames.auto.gni refactor: replace ipcRendererUtils.invoke() with ipcRendererInternal.invoke() (#19574) 2019-08-23 15:45:50 -07:00
filenames.gni chore: remove native_mate (Part 3) (#20131) 2019-09-06 14:52:54 +09:00
LICENSE fix: update license year (#16287) 2019-01-05 12:53:20 -08:00
package.json Bump v8.0.0-nightly.20190913 2019-09-13 08:31:01 -07:00
README.md docs: update badges (#18955) 2019-06-24 14:09:17 -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 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 test: run all tests on arm linux platforms (#19318) 2019-07-19 16:15:47 -07:00
vsts-arm32v7.yml chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) 2019-07-02 18:22:09 -07:00
vsts-arm64v8.yml test: run all tests on arm linux platforms (#19318) 2019-07-19 16:15:47 -07:00
yarn.lock feat: add nativeTheme.themeSource to allow apps to override Chromiums theme choice (#19960) 2019-09-05 10:57:04 -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.