No description
Find a file
shelley vohr e8a57376f0
Merge pull request #12000 from kalikiana/quoted-snap-version
tutorial: Surround the snap version in quotes
2018-02-21 16:42:49 -05:00
.circleci Set DISPLAY variable for xvfb 2018-01-17 12:57:42 -05:00
.github add typing cat to first PR comment (#11964) 2018-02-19 17:45:14 -06:00
atom Merge pull request #11956 from brenca/transparent-window-devtools-fix 2018-02-21 19:54:35 +09:00
brightray Explicitly disable executable stack in all Linux binaries 2018-02-21 17:57:53 +01:00
chromium_src Merge pull request #11595 from YurySolovyov/fileicon-task-scheduler 2018-02-13 05:11:22 +11:00
default_app Replace default_app icon 2017-12-07 16:10:45 -05:00
docs Merge pull request #12000 from kalikiana/quoted-snap-version 2018-02-21 16:42:49 -05:00
docs-translations Merge https://github.com/kstar0714/electron 2017-11-22 00:45:03 -08:00
lib Merge pull request #11968 from electron/refactor-menu-popup 2018-02-21 14:29:52 -05:00
npm revert electron-download dependency to ^3.0.1 2017-11-03 09:45:09 -05:00
script Merge pull request #11879 from electron/fix-gtk-deprecations 2018-02-16 10:01:01 -05:00
spec Merge pull request #11968 from electron/refactor-menu-popup 2018-02-21 14:29:52 -05:00
tools Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
vendor Fix the cyclic reference in menu delegate (#11967) 2018-02-20 10:11:35 -06:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.gitignore Ignore all npmrc and package-lock 2017-12-04 11:05:04 -05:00
.gitmodules Move brightray submodules to root vendor 2017-05-10 13:27:22 -07:00
.node-version Bump node version number 2017-09-15 00:58:31 +02: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
CODE_OF_CONDUCT.md fix word CODE_OF_CONDUCT.md 2017-11-21 17:15:14 -08:00
common.gypi Fix "nghttp2" build 2017-11-24 10:58:53 +09:00
CONTRIBUTING.md enhance documentation around contributing to electron (#11887) 2018-02-12 08:09:38 -06:00
Dockerfile Enable testing with python-dbusmock 2017-12-05 15:01:01 -05:00
Dockerfile.arm64 replace gtk2 with gtk3 in dockerfiles 2018-02-15 15:03:14 -06:00
Dockerfile.armv7 replace gtk2 with gtk3 in dockerfiles 2018-02-15 15:03:14 -06:00
Dockerfile.circleci Enable testing with python-dbusmock 2017-12-05 15:01:01 -05:00
electron.gyp Make run-as-node mode optional (#11701) 2018-01-23 18:17:15 -05:00
features.gypi Make run-as-node mode optional (#11701) 2018-01-23 18:17:15 -05:00
filenames.gypi Implement App-Scoped Security scoped bookmarks (#11711) 2018-02-12 13:25:06 -05:00
Jenkinsfile Add 1 hour timeout 2017-12-04 13:19:51 -05:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package.json bump electron-typescript-defs to 1.3.2 2018-02-21 12:42:07 -05:00
README.md Fix 'electron-versioning' link in README.md 2017-12-13 22:18:00 +09:00
SECURITY.md 📝 Link to security tutorial 2018-01-28 16:54:58 -08:00
toolchain.gypi Some compiler flags are clang only 2017-11-21 21:48:06 +09:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Jenkins Build Status devDependency Status Join the Electron Community on Slack

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹. View these docs in other languages at electron/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 electron@github.com.

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 as Electron does not follow semantic versioning. 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/electron-i18n.

Community

You can ask questions and interact with the community in the following locations:

Check out awesome-electron for a community maintained list of useful example apps, tools and resources.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.