electron/electron


:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS

https://electronjs.org

License: MIT

Language: C++

Keywords: c-plus-plus, chrome, css, electron, html, javascript, nodejs, v8


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.

Contributing

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.

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.

Project Statistics

Sourcerank 21
Repository Size 65.9 MB
Stars 79,058
Forks 10,506
Watchers 2,799
Open issues 1,238
Dependencies 1,336
Contributors 647
Tags 726
Created
Last updated
Last pushed

Top Contributors See all

Cheng Zhao Kevin Sawicki Robo Samuel Attard Shelley Vohr Zeke Sikelianos Jeremy Apthorp Alexey Kuzmin Plusb Preco John Kleinschmidt Adam Roben Felix Rieseberg Milan Burda Haojian Wu Charles Kerr Anaรฏs Betts Heilig Benedek Electron Bot Max Ogden Jessica Lord

Packages Referencing this Repo

electron-nightly
Build cross platform desktop apps with JavaScript, HTML, and CSS
Latest release 9.0.0-nightly.20191203 - Updated - 79.1K stars
electron
Build cross platform desktop apps with JavaScript, HTML, and CSS
Latest release 8.0.0-beta.4 - Updated - 79.1K stars
mannyelectronite
Build cross platform desktop apps with JavaScript, HTML, and CSS
Latest release 7.0.0-nightly.20190723 - Published - 79.1K stars
@fivepointseven/electron
Build cross platform desktop apps with JavaScript, HTML, and CSS
Latest release 7.0.0-nightly.20190523 - Published - 79.1K stars
@jcarras/electron-win-offline
Build cross platform desktop apps with JavaScript, HTML, and CSS
Latest release 2.0.1 - Published - 79.1K stars
electronnodist
Build cross platform desktop apps with JavaScript, HTML, and CSS
Latest release 1.7.11 - Updated - 79.1K stars

Recent Tags See all

v8.0.0-beta.4 December 04, 2019
v9.0.0-nightly.20191203 December 03, 2019
v7.1.3 December 02, 2019
v9.0.0-nightly.20191202 December 02, 2019
v9.0.0-nightly.20191202 December 02, 2019
v9.0.0-nightly.20191201 December 01, 2019
v9.0.0-nightly.20191130 November 30, 2019
v9.0.0-nightly.20191129 November 29, 2019
v9.0.0-nightly.20191128 November 28, 2019
v9.0.0-nightly.20191127 November 27, 2019
v9.0.0-nightly.20191126 November 26, 2019
v9.0.0-nightly.20191125 November 25, 2019
v9.0.0-nightly.20191124 November 24, 2019
v9.0.0-nightly.20191123 November 23, 2019
v9.0.0-nightly.20191122 November 22, 2019

Interesting Forks See all

discordapp/electron
Build cross platform desktop apps with web technologies
C++ - MIT - Last pushed - 7 stars - 2 forks
mozilla/positron-electron
Build cross platform desktop apps with JavaScript, HTML, and CSS
C++ - MIT - Last pushed - 7 stars - 14 forks
preco21/electron
Web ๊ธฐ์ˆ ์„ ์‚ฌ์šฉํ•˜์—ฌ ๋ฐ์Šคํฌํƒ‘ ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜์„ ๊ฐœ๋ฐœ - Atom Electron ํ•œ๊ตญ์–ด ์ฐธ์กฐ ๋ฌธ์„œ
C++ - MIT - Last pushed - 7 stars
thomsonreuters/electron
Build cross platform desktop apps with JavaScript, HTML, and CSS
C++ - MIT - Last pushed - 5 stars - 1 forks
leo-lb/electron
:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS - PPC64LE FORK
C++ - MIT - Last pushed - 4 stars - 2 forks

Something wrong with this page? Make a suggestion

Last synced: 2019-07-01 18:50:37 UTC

Login to resync this repository