The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
:memo: Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹 🇵🇱. View these docs in other languages at electron/i18n.
Follow @ElectronJS on Twitter for important announcements.
To install prebuilt Electron binaries, use [
](https://docs.npmjs.com/). The preferred method is to install Electron as a development dependency in your app:
npm install electron --save-dev [--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
flag. For info on how to manage Electron versions in your apps, seeElectron versioning.
For more installation options and troubleshooting tips, seeinstallation.
](https://github.com/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 theelectron/electron-quick-startrepository 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
Most people use Electron from the command line, but if you require
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)
Find documentation translations in electron/i18n.
If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.
Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found in the support document.
When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.