Repository files navigation

📝 Available Translations: 🇨🇳 🇹🇼 🇧🇷 🇪🇸 🇰🇷 🇯🇵 🇷🇺 🇫🇷 🇹🇭 🇳🇱 🇹🇷 🇮🇩 🇺🇦 🇨🇿 🇮🇹.View these docs in other languages atelectron/electron-i18n.

The Electron framework lets you write cross-platform desktop applicationsusing JavaScript, HTML and CSS. It is based onNode.js andChromium and is used by theAtomeditor and many otherapps.

Follow@ElectronJS on Twitter for importantannouncements.

This project adheres to the Contributor Covenantcode of conduct.By participating, you are expected to uphold this code. Please report unacceptablebehavior toelectron@github.com.

To install prebuilt Electron binaries, usenpm.The preferred method is to install Electron as a development dependency in yourapp:

npm install electron --save-dev --save-exact

The--save-exact flag is recommended as Electron does not follow semanticversioning. For info on how to manage Electron versions in your apps, seeElectron versioning.

For more installation options and troubleshooting tips, seeinstallation.

Clone and run theelectron/electron-quick-startrepository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-startcd electron-quick-startnpm installnpm start

• electronjs.org/docs - all of Electron's documentation
• electron/electron-quick-start - a very basic starter Electron app
• electronjs.org/community#boilerplates - sample starter apps created by the community
• electron/simple-samples - small applications with ideas for taking them further
• electron/electron-api-demos - an Electron app that teaches you how to use Electron
• hokein/electron-sample-apps - small demo apps for the various Electron APIs

Most people use Electron from the command line, but if you requireelectron insideyourNode app (not your Electron app) it will return the file path to thebinary. Use this to spawn Electron from Node scripts:

constelectron=require('electron')constproc=require('child_process')// will print something similar to /Users/maf/.../Electronconsole.log(electron)// spawn Electronconstchild=proc.spawn(electron)

• China

Find documentation translations inelectron/electron-i18n.

You can ask questions and interact with the community in the followinglocations:

• electron category on the Atomforums
• #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)
• electron-pl(Poland)

Check outawesome-electronfor a community maintained list of useful example apps, tools and resources.

MIT

When using the Electron or other GitHub logos, be sure to follow theGitHub logo guidelines.