electron
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

electron

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

6.0.4  •  Published 2 months ago  •  by electron  •  MIT License

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status

📝 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.

Ready for the next level?
Join Devstore's founding team to build the world's largest open-source knowledgebase, work with the hottest technologies, and be part of something great

Popularity

Weekly Downloads
183.1K
Stars
75.6K

Maintenance

Development

Last ver 2 months ago
Created 7 years ago
Last commit 3 months ago
4 hours between commits

Technology

Node version: 10.16.0
465K unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

80 contributors
Cheng Zhao
Maintainer, 30 commits, 833 merges, 295 PRs
Works at GitHub
Samuel Attard
Maintainer, 174 commits
Works at SlackHQ
Jeremy Apthorp
Maintainer, 152 commits
Works at tinyspeck
Shelley Vohr
Maintainer, 151 commits
Milan Burda
Maintainer, 114 commits
Works at Microsoft
Electron Bot
Maintainer, 104 commits
Works at GitHub

Tags

electron
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things