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:

# 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

• China

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

• Brazilian Portuguese
• Korean
• Japanese
• Spanish
• Simplified Chinese
• Traditional Chinese
• Turkish
• Thai
• Ukrainian
• Russian
• French
• Indonesian

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:

• electron category on the Atom forums
• #atom-shell channel on Freenode
• Atom channel on Slack
• electron-ru (Russian)
• electron-br (Brazilian Portuguese)
• electron-kr (Korean)
• electron-jp (Japanese)
• electron-tr (Turkish)
• electron-id (Indonesia)

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.