electron README

The project's README from github.com/electron/electron. As one markdown file: README.md.

Electron Logo

GitHub Actions Build Status Electron Discord Invite

:memo: Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on our Crowdin project.

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 Visual Studio Code 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].

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

For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

In general, Electron tries to align with Chromium on platform support.

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.

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('node:child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

Mirrors

See the Advanced Installation Instructions to learn how to use a custom mirror.

Documentation translations

We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.

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 on the Community page.

License

MIT

When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.

electron (electron/electron)

Searching Database…

123.4K ·GitHub
Что это такое?Electron — это фреймворк для создания кроссплатформенных десктоп-приложений на JavaScript, HTML и CSS. Он построен на Node.js и Chromium, и его используют такие приложения, как Visual Studio Code.
Как добавить его в проект?Установите его через npm как зависимость для разработки (dev dependency) — npm сам скачает готовые бинарники Electron; в документации описаны другие варианты установки и решение проблем.
Нужно ли что-то ещё, кроме npm, чтобы начать разработку?Достаточно Node.js и npm в среде разработки; сам бинарник Electron уже содержит Chromium и Node.js, поэтому тем, кто запускает ваше приложение, больше ничего ставить не нужно.
Насколько старой может быть моя ОС, чтобы оно работало?На macOS нужна Ventura или новее, на Windows — 10 или выше; на Linux поддерживаются те версии дистрибутивов, которые до сих пор поддерживаются и Chromium, и авторами дистрибутива.
Под какие операционные системы можно собирать приложения?Каждый релиз содержит готовые бинарники для macOS (64-битные Intel и Apple Silicon), Windows (x64 и arm64) и Linux (x64 и arm64).
Есть ли подвох в лицензии MIT?Нет — это обычная MIT. Единственное отмеченное условие: использование логотипов Electron должно соответствовать trademark-политике OpenJS Foundation.
Что такое Electron Fiddle и нужен ли он мне?Это отдельный вспомогательный инструмент, чтобы создавать, запускать и упаковывать небольшие Electron-эксперименты, просматривать примеры кода для каждого API Electron и пробовать разные версии Electron — он сделан специально для того, чтобы первые шаги давались проще.
Могу ли я запускать Electron из собственных Node-скриптов?Да — если подключить electron (require) в обычном Node-приложении (не в вашем Electron-приложении), вы получите путь к бинарнику, который можно запустить из Node-скриптов; но чаще всего его просто используют из командной строки.
У меня npm работает медленно — есть ли обходной путь?Да — в документе Advanced Installation Instructions описано, как установить Electron с собственного зеркала; эта инструкция написана для пользователей из Китая.
Creator
electron
Size
219.7 MB
Stars
123.4K
Age
13y
Commits · 90 Days