Build cross platform desktop apps with JavaScript, HTML, and CSS
Clone or download
Pull request Compare This branch is 8060 commits behind electron:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
atom
chromium_src
default_app
docs-translations
docs
lib
script
spec
tools
vendor
.clang-format
.gitignore
.gitmodules
.node-version
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE
README.md
appveyor.yml
common.gypi
electron.gyp
filenames.gypi
package.json
toolchain.gypi

README.md

Electron Logo

Travis Build Status AppVeyor Build Status devDependency Status Join the Electron Community on Slack

📝 Available Translations: Korean | Simplified Chinese | Brazilian Portuguese | Traditional Chinese

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.

Downloads

To install prebuilt Electron binaries, use npm (or yarn):

# Install as a development dependency
npm install electron --save-dev

# Install the `electron` command globally in your $PATH
npm install electron -g

See the releases page for prebuilt binaries, debug symbols, and more.

Mirrors

Documentation

Guides and the API reference are located in the docs directory. It also contains documents describing how to build and contribute to Electron.

Documentation Translations

Quick Start

Clone and run the electron/electron-quick-start repository to see a minimal Electron app in action.

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.