No description
Find a file
2018-10-04 10:10:48 -04:00
.circleci chore: checkout the arm resources during publish sync 2018-10-04 14:14:53 +10:00
.github chore: ask for specific info in bug templates (#14229) 2018-08-22 08:21:54 -07:00
.vsts chore: add GN linting (#14678) 2018-10-03 18:03:26 -05:00
atom Revert "Bump v4.0.0-nightly.20181003" 2018-10-04 13:45:20 +10:00
brightray chore: fix GN linting issue in brightray 2018-10-04 12:10:18 +10:00
build Merge pull request #14964 from electron/chromium-upgrade/68 2018-10-04 12:04:53 +10:00
buildflags build: define compile time features with buildflag header (#14840) 2018-10-01 16:00:53 -04:00
chromium_src Revert "feat: upgrade to Chromium 68.0.3440.128 and Node 10.11.0 (#14677)" (#14963) 2018-10-04 12:03:15 +10:00
components/pepper_flash Rename buildflag_headers for consistency 2018-09-11 20:21:32 +02:00
default_app fix: default_app incorrect loading by url (#14940) 2018-10-03 08:10:22 -07:00
docs feat: remove needless mojave dark mode APIs and add instructions on how to use the macOS replacement (#14895) 2018-10-02 14:44:50 +10:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib feat: add security warnings to sandboxed renderers (#14869) 2018-10-03 21:36:12 +02:00
native_mate chore: add GN linting (#14678) 2018-10-03 18:03:26 -05:00
npm chore: update to standard 12 2018-09-14 14:57:01 +10:00
patches Revert "feat: upgrade to Chromium 68.0.3440.128 and Node 10.11.0 (#14677)" (#14963) 2018-10-04 12:03:15 +10:00
script Merge pull request #14964 from electron/chromium-upgrade/68 2018-10-04 12:04:53 +10:00
spec test: disable one test in base_unittests (#14968) 2018-10-04 10:00:30 -04:00
tools chore: fix path to dump_syms in the windows breakpad tool 2018-09-28 15:57:16 +10:00
vendor chore: remove vendored depot_tools (#14676) 2018-09-19 09:37:38 -07: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 clarify purpose of .env.example 2018-07-11 12:55:15 -07:00
.eslintrc refactor: add prefer-const to .eslintrc + fix errors (#14880) 2018-10-02 11:56:31 +10:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore chore: replace standard with eslint-config-standard and add custom rules (#14636) 2018-09-16 03:51:23 +10:00
.gitmodules chore: remove vendored depot_tools (#14676) 2018-09-19 09:37:38 -07:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml chore: fix ffmpeg upload path and always generate node headers 2018-09-29 12:27:29 +10:00
BUILD.gn chore: enable -pie for linux builds (#14962) 2018-10-04 10:10:48 -04: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 Revert "feat: upgrade to Chromium 68.0.3440.128 and Node 10.11.0 (#14677)" (#14963) 2018-10-04 12:03:15 +10:00
Dockerfile ci: migrate libcc's Dockerfile to electron and update it (#14786) 2018-09-25 15:30:22 -04: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
electron_paks.gni chore: add GN linting (#14678) 2018-10-03 18:03:26 -05:00
filenames.gni chore: add GN linting (#14678) 2018-10-03 18:03:26 -05:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package-lock.json Revert "Bump v4.0.0-nightly.20181003" 2018-10-04 13:45:20 +10:00
package.json Revert "Bump v4.0.0-nightly.20181003" 2018-10-04 13:45:20 +10:00
README.md docs: Add Electron Fiddle to the readme (#14396) 2018-08-31 22:56:55 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
VERSION Revert "Bump v4.0.0-nightly.20181003" 2018-10-04 13:45:20 +10:00
vsts.yml ci: Use VSTS checkout of electron (#14926) 2018-10-02 16:21:27 -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 & 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.