No description
Find a file
John Kleinschmidt 376094fc0c
Merge pull request #13515 from nornagon/gn-linux
chore: [gn] fix linux build
2018-07-11 08:02:42 -04:00
.circleci Add/update slack notifications 2018-07-06 10:23:31 -04:00
.github docs: update pr template with checklist (#13270) 2018-06-18 13:58:30 -07:00
atom Merge pull request #13540 from electron/breakpad-compat 2018-07-10 08:30:56 -04:00
brightray build: [gn] depend on /gtk instead of /gtk3 2018-07-10 13:42:41 -07:00
build build: [gn] use clang and custom stdlib when building node on linux 2018-07-10 13:42:36 -07:00
chromium_src chore: fix more chromium-style errors in windows code (#13487) 2018-06-28 14:20:11 -07:00
default_app Replace default_app icon 2017-12-07 16:10:45 -05:00
docs docs: add link to Chromium windows debugging docs 2018-06-27 23:06:30 +02:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib Enable webview in sandbox renderer (#13435) 2018-07-03 02:06:26 +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 Move github release checking to node.js 2018-07-10 09:40:24 -04:00
spec test: Better path compare than just strings (#13548) 2018-07-10 21:38:11 +10:00
tools update mac symbol dump (#12982) 2018-05-21 10:01:17 +09:00
vendor chore: breakpad #include compatibility between GN and GYP 2018-07-09 16:53:06 -07: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 run test.py with --rebuild_native_modules (#13570) 2018-07-05 16:53:11 -05:00
BUILD.gn build: [gn] depend on /gtk instead of /gtk3 2018-07-10 13:42:41 -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 chore: [gn] use merged-in native_mate 2018-06-29 12:01:09 -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 Merge pull request #13463 from electron/remove_wtl 2018-06-29 10:00:50 -07:00
features.gypi build: move pepper flash behind feature flag 2018-06-21 17:02:12 +05:30
filenames.gypi refactor: add promise helper and change whenReady to be native impl (#13115) 2018-06-27 16:06:08 -05:00
LICENSE prepare for merging to electron 2018-06-22 11:29:57 +10:00
package-lock.json Fix vulnerabilities both top-level and in spec (#13029) 2018-05-21 21:15:18 -07:00
package.json update electron-typescript-definitions to 1.3.5 2018-05-25 10:41:26 -07: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 Add/update slack notifications 2018-07-06 10:23:31 -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.