先决条件

跟随本教程

这是 Electron 教程的第 1 部分。

1. 先决条件
2. 构建您的第一个应用
3. 使用预加载脚本
4. 添加功能
5. 打包您的应用程序
6. 发布和更新

Electron 是一个使用 JavaScript、HTML 和 CSS 构建桌面应用程序的框架。通过将 Chromium 和 Node.js 嵌入到单个二进制文件中，Electron 允许您创建可在 Windows、macOS 和 Linux 上运行的跨平台应用，且只需一套 JavaScript 代码库。

本教程将引导您完成使用 Electron 开发桌面应用程序并将其分发给最终用户的过程。

目标

本教程首先引导您从头开始拼凑一个最小的 Electron 应用程序，然后教您如何使用 Electron Forge 打包并分发给用户。

如果您希望通过单命令样板启动项目，我们建议您从 Electron Forge 的 create-electron-app 命令开始。

假设

Electron 是 Web 应用程序的本地封装层，并在 Node.js 环境中运行。因此，本教程假定您通常熟悉 Node 和前端 Web 开发基础知识。如果您需要在继续之前进行一些背景阅读，我们推荐以下资源

• Web 入门 (MDN Web Docs)
• Node.js 简介

所需工具

代码编辑器

您将需要一个文本编辑器来编写代码。我们建议使用 Visual Studio Code，当然您也可以选择您喜欢的任何编辑器。

命令行

在本教程中，我们将要求您使用各种命令行界面 (CLI)。您可以将这些命令键入到系统的默认终端中

• Windows：命令提示符或 PowerShell
• macOS：终端
• Linux：因发行版而异（例如 GNOME Terminal、Konsole）

大多数代码编辑器也带有集成的终端，您也可以使用。

Git 和 GitHub

Git 是一个常用的源代码版本控制系统，而 GitHub 是一个构建在其之上的协作开发平台。虽然两者都不是构建 Electron 应用程序的必要条件，但我们将在本教程的后面使用 GitHub 版本来设置自动更新。因此，我们将要求您

• 创建一个 GitHub 帐户
• 安装 Git

如果您不熟悉 Git 的工作原理，我们建议阅读 GitHub 的 Git 指南。如果您喜欢使用可视化界面而不是命令行，也可以使用 GitHub Desktop 应用程序。

我们建议您在开始本教程之前创建一个本地 Git 仓库并将其发布到 GitHub，并在每个步骤后提交您的代码。

通过 GitHub Desktop 安装 Git

如果您尚未安装 Git，GitHub Desktop 将在您的系统上安装最新版本的 Git。

Node.js 和 npm

要开始开发 Electron 应用程序，您需要在您的系统上安装 Node.js 运行时及其捆绑的 npm 包管理器。我们建议您使用最新的长期支持 (LTS) 版本。

提示

请使用适用于您平台的预构建安装程序安装 Node.js。否则，您可能会遇到与不同开发工具的不兼容问题。如果您使用的是 macOS，我们建议使用包管理器，如 Homebrew 或 nvm，以避免任何目录权限问题。

要检查 Node.js 是否安装正确，您可以在运行 node 和 npm 命令时使用 -v 标志。这些命令应打印出已安装的版本。

$ node -v
v16.14.2
$ npm -v
8.7.0

注意

虽然您需要在本地安装 Node.js 以搭建 Electron 项目，但 Electron 不使用您系统上安装的 Node.js 来运行其代码。相反，它自带了自己的 Node.js 运行时。这意味着您的最终用户无需自行安装 Node.js 作为运行您的应用程序的先决条件。

要检查您的应用程序中运行的 Node.js 版本，您可以访问主进程或预加载脚本中的全局 process.versions 变量。您也可以参考 https://releases.electronjs.org/releases.json。