7kbird/electron

Build cross platform desktop apps with web technologies

⚡ Formerly known as Atom Shell ⚡

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 in the Atom editor.

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 atom@github.com.

Downloads

Prebuilt binaries and debug symbols of Electron for Linux, Windows and OS X can be found on the releases page.

You can also use npm to install prebuilt electron binaries:

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

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

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
• Ukrainian
• Russian

Quick Start

Clone and run the atom/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-br (Brazilian Portuguese)
• electron-kr (Korean)

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