No description
Find a file
John Kleinschmidt 6edbb3e3ed
Merge pull request #13662 from electron/nightly-updates
chore: Updates for nightly builds
2018-07-17 11:13:20 -04:00
.circleci Make sure artifacts are properly saved for nightly release builds 2018-07-16 17:07:48 -04:00
.github docs: update pr template with checklist (#13270) 2018-06-18 13:58:30 -07:00
atom fix: create a window capturer correctly (#13689) 2018-07-17 14:20:50 +10:00
brightray build: [gn] use libnotify from custom sysroot 2018-07-16 17:33:42 -07:00
build Merge pull request #13636 from nornagon/gn-release 2018-07-12 10:45:21 -04: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 refactor: remove experimentalCanvasFeatures property (#13684) 2018-07-16 13:32:42 -07:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib fix: remove race condition for executeJavaScript (#13691) 2018-07-17 13:32:28 +10:00
native_mate chore: fix chromium-style errors in native_mate 2018-06-29 12:01:09 -07:00
npm feat: upgrade electron-download to 4.x 2018-05-17 23:16:27 -07:00
script chore: Don't show download stats of libchromiumcontent for CI. (#13681) 2018-07-16 11:19:53 -07:00
spec fix: create a window capturer correctly (#13689) 2018-07-17 14:20:50 +10:00
tools build: handle win32 path separator in js2asar (#13694) 2018-07-17 15:31:06 +10:00
vendor Make sure artifacts are properly saved for nightly release builds 2018-07-16 17:07:48 -04:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.gitignore prepare for merging to electron 2018-06-22 11:29:57 +10: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 prepare for merging to electron 2018-06-22 11:29:57 +10: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 win] link comctl32.lib to fix component build 2018-07-13 17:21:49 -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 Make sure artifacts are properly saved for nightly release builds 2018-07-16 17:07:48 -04: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
features.gypi build: move pepper flash behind feature flag 2018-06-21 17:02:12 +05:30
filenames.gypi refactor: clean up the default app, add CSP (#13437) 2018-07-17 10:26:58 +10:00
LICENSE prepare for merging to electron 2018-06-22 11:29:57 +10:00
package-lock.json refactor: clean up the default app, add CSP (#13437) 2018-07-17 10:26:58 +10:00
package.json refactor: clean up the default app, add CSP (#13437) 2018-07-17 10:26:58 +10:00
README.md prepare for merging to electron 2018-06-22 11:29:57 +10: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.