入门

使用完整的构建管道快速搭建 Electron 项目

概述

Electron Forge 是一个用于打包和分发 Electron 应用的一体化工具。它将许多单一用途的软件包组合在一起，创建了一个开箱即用的完整构建管道，包括代码签名、安装程序和工件发布。对于高级工作流，可以通过其插件 API在 Forge 生命周期中添加自定义构建逻辑。自定义构建和存储目标可以通过创建自己的构建器和发布者来处理。

创建新应用

要开始使用 Electron Forge，我们首先需要使用create-electron-app初始化一个新项目。此脚本是 Forge 的Init命令的便捷包装器。

Electron Forge 目前仅支持 npm 和 Yarn Classic。如果您使用的是 Yarn >=2，请使用nodeLinker: node-modules安装模式。

npm init electron-app@latest my-app

使用模板

Forge 的初始化脚本可以使用--template=[template-name]标志添加额外的模板代码。

npm init electron-app@latest my-app -- --template=webpack

目前有四个第一方模板

  • webpack

  • webpack-typescript

  • vite

  • vite-typescript

所有这些模板都构建在打包生产环境 JavaScript 代码的插件周围，并包含一个开发服务器以提供更好的开发体验。

我们强烈建议在初始化应用程序时使用这些模板，以利用现代前端 JavaScript 工具。

要了解有关为 Electron Forge 编写自己的模板的更多信息，请查看编写模板指南！

启动您的应用

您现在应该有一个名为my-app的目录，其中包含基本 Electron 应用所需的所有文件。

cd my-app
npm start

构建分发包

所以您在那里有一个很棒的应用程序，并且您想将其打包并与世界共享。如果您运行make脚本，Electron Forge 将为您生成特定于平台的分发包，以便与所有人共享。有关您可以生成哪种分发包的更多信息，请查看构建器文档。

npm run make

发布您的应用

现在您拥有可以与用户共享的分发包。如果您运行publish脚本，Electron Forge 然后将使用您选择的发布方法为您发布特定于平台的分发包。例如，如果您想将资产发布到 GitHub，您可以使用以下命令安装 GitHub 发布者依赖项

npm install --save-dev @electron-forge/publisher-github

一旦您根据文档配置了发布者，请运行以下命令上传您的分发包

npm run publish

有关我们当前支持的发布者的更多信息，请查看发布者文档。

高级用法

一旦您启动、构建和发布了基本应用程序，就可以添加自定义配置，这可以在forge.config.js文件中完成。配置选项在配置文档中指定。

您还可以查看有关我们一些更高级功能的文档，例如

下一步导入现有项目

上次更新