No description
Find a file
Gellert Hegyi 4bcf0e34c5 fix: window.setVibrancy parameter passing (#13627)
* fix: setVibrancy parameter passing

* fix: uses correct parameter types for setVibrancy
2018-07-30 11:29:18 +10:00
.circleci build: [gn] centralize GN args under build/args/*.gn 2018-07-25 14:24:45 -07:00
.github Update docs on semantic requirements for #13359 (#13365) 2018-07-18 10:41:58 -05:00
atom fix: window.setVibrancy parameter passing (#13627) 2018-07-30 11:29:18 +10:00
brightray build: [gn] fix linking against base_static (#13810) 2018-07-26 08:30:37 -07:00
build build: [gn win] fix path names in js2asar 2018-07-27 12:08:39 -07:00
chromium_src chore: fix more chromium-style errors in windows code (#13487) 2018-06-28 14:20:11 -07:00
default_app feat: support chrome:// URLs in default_app (#13575) 2018-07-17 17:23:44 +10:00
docs 📝 First draft: Here be dragons (#13835) 2018-07-30 11:19:23 +10:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib fix: util.promisify(setTimeout) (#13840) 2018-07-30 11:14:04 +10:00
native_mate build: [gn] move native_mate build config to native_mate dir (#13706) 2018-07-18 11:45:13 +10:00
npm feat: upgrade electron-download to 4.x 2018-05-17 23:16:27 -07:00
script Merge pull request #13739 from electron/fix-rebuild-native-modules 2018-07-20 11:20:32 -04:00
spec chore(tests): allow usage of deprecated APIs in tests (#13659) 2018-07-30 11:27:58 +10:00
tools build: [gn win] fix path names in js2asar 2018-07-27 12:08:39 -07:00
vendor build: Bump libcc to latest (#13821) 2018-07-26 08:26:08 -07:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.env.example clarify purpose of .env.example 2018-07-11 12:55:15 -07:00
.gitignore Merge pull request #12921 from electron/commit-package-lock 2018-05-16 11:47:21 -04:00
.gitmodules rename back to expected values 2018-06-22 11:42:55 +10:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
.travis.yml Add arm64 task in travis ci 2017-08-22 10:02:51 +09:00
appveyor.yml Make sure artifacts are properly saved for nightly release builds 2018-07-16 17:07:48 -04:00
BUILD.gn build: [gn] fix resource path conflict on mac (#13824) 2018-07-27 08:04:03 -07:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
common.gypi Disable node options in node config (#13311) 2018-06-20 13:08:24 +10:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
DEPS build: [gn] win and linux depend on :packed_resources 2018-07-25 15:49:42 -07:00
Dockerfile Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
Dockerfile.arm64 Newer CI images (#12188) 2018-03-08 22:07:50 -05:00
Dockerfile.arm64v8 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.armv7 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.circleci Use Node.js 10 for CI builds 2018-06-19 11:49:45 +10:00
electron.gyp refactor: DwmGetColorizationColor does not have to be dynamically resolved 2018-07-12 22:28:44 +02:00
electron_paks.gni build: [gn] pack ui_strings in locales (#13827) 2018-07-27 08:05:36 -07:00
features.gypi build: move pepper flash behind feature flag 2018-06-21 17:02:12 +05:30
filenames.gypi fix: use webContentsId with contextId together (#13749) 2018-07-24 16:21:38 +09:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package-lock.json new release notes generator 2018-07-18 02:25:56 +10:00
package.json new release notes generator 2018-07-18 02:25:56 +10:00
README.md Update installation instructions 2018-05-14 14:06:22 +03:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
toolchain.gypi chrome style plugin: remove check-auto-raw-pointer option 2018-06-19 11:49:43 +10:00
vsts.yml Make sure artifacts are properly saved for nightly release builds 2018-07-16 17:07:48 -04:00

Electron Logo

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

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.