electron

Build cross platform desktop apps with JavaScript, HTML, and CSS

Electron Logo

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

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 [email protected]

Downloads

Prebuilt binaries and debug symbols of Electron for Linux, Windows and macOS 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

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: - electron category on the Atom forums - #atom-shell channel on Freenode - Atom channel on Slack - 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.

Related Repositories

awesome-electron

awesome-electron

Useful resources for creating apps with Electron ...

electron-packager

electron-packager

Customize and package your Electron app with OS-specific bundles (.app, .exe, etc.) via JS or CLI ...

electron-builder

electron-builder

A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box ...

electron-api-demos

electron-api-demos

Explore the Electron APIs ...

electron-quick-start

electron-quick-start

Clone to try a simple Electron app ...