:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
Перейти к файлу
Tautvydas Žilys fd6fd25d56 Update fsevents package so it works with current node. 2020-07-02 13:02:35 -07:00
.circleci docs: Update the sccache name (#20462) (#20862) (#20880) 2019-11-01 12:10:01 -04:00
.github chore: upgrades-wg owns DEPS (#19832) 2019-08-19 14:04:08 -07:00
atom Bump v5.0.13 2019-12-16 19:11:25 -08:00
build fix: remove .pdb from symbol file names (#19503) 2019-07-30 09:21:42 -07:00
buildflags fix: port OSR code to new viz compositor codepath (backport: 5-0-x) (#17572) 2019-04-03 18:08:22 -05:00
chromium_src fix: enable autofill popups on mac (backport: 5-0-x) (#17888) 2019-04-22 14:55:38 -07:00
components/pepper_flash chore: fix linking errors on Windows 2019-02-14 12:38:36 -08:00
default_app fix: app.getAppPath() returning default-app path for files or directories without package.json (#18763) (#18894) 2019-06-21 08:54:32 -07:00
docs docs: Update the sccache name (#20462) (#20862) (#20880) 2019-11-01 12:10:01 -04:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib fix: properly generate requestID in webContents.printToPDF() (#20812) 2019-10-31 08:48:27 -07:00
manifests chore: use c++ manifests instead of json 2019-02-14 12:38:36 -08:00
native_mate fix: retain menu when popuping (#21227) 2019-11-21 19:47:05 +09:00
npm chore: update @types/node dep (#16174) 2018-12-21 12:59:42 -05:00
patches Add page size fix patch. 2020-07-02 10:53:33 -07:00
script fix: trim branch name before comparing to master (#19853) (#20922) 2019-11-01 16:51:00 -04:00
spec fix: properly generate requestID in webContents.printToPDF() (#20812) 2019-10-31 08:48:27 -07:00
tools fix: dump correct breakpad symbols on macOS (#19157) 2019-07-09 09:47:36 +09:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore ci: migrate libcc's Dockerfile to electron and update it (#14786) 2018-09-25 15:30:22 -04:00
.env.example build: move Windows release builds to AppVeyor cloud (#18604) 2019-06-04 10:29:37 -04:00
.eslintrc.json chore(eslint): add extension to .eslintrc file (#15020) 2018-10-08 14:21:34 -05:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore feat: Upgrade to Chromium 71.0.3578.98 (#15966) 2019-01-11 17:00:43 -08:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
BUILD.gn fix: don't try to dump swiftshader symbols on mac (#19261) 2019-07-15 20:53:57 -07:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
DEPS build: move our node fork to our patch system (#19292) 2019-07-16 16:50:26 -07:00
Dockerfile build: install python-dbusmock via pip for a Docker container (#18599) 2019-06-04 09:41:55 -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_VERSION Bump v5.0.13 2019-12-16 19:11:25 -08:00
LICENSE fix: update license year (#16287) 2019-01-05 12:53:20 -08:00
README.md docs: add Azure Pipelines status (#15455) 2018-10-29 12:18:34 -04:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
appveyor.yml ci: do not run WOA builds on older versions of Electron (#20090) 2019-09-04 17:23:27 -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 12:38:36 -08:00
electron_strings.grdp fix: correct 'Entire screen' to ' Entire Screen' (#20300) 2019-09-20 07:44:19 -07:00
filenames.gni fix: retain menu when popuping (#21227) 2019-11-21 19:47:05 +09:00
package-lock.json Bump v5.0.13 2019-12-16 19:11:25 -08:00
package.json Update fsevents package so it works with current node. 2020-07-02 13:02:35 -07:00
vsts-arm-test-steps.yml chore: use manual invocation of npx yarn (#18920) 2019-06-24 07:54:32 -07:00
vsts-arm32v7.yml ci: fix flaky test on arm (5-0-x) (#19806) 2019-08-16 16:36:59 -04:00
vsts-arm64v8.yml ci: fix flaky test on arm (5-0-x) (#19806) 2019-08-16 16:36:59 -04:00

README.md

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.

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.