開始使用

快速建立具有完整建置流程的 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 檔案中加入您的自訂設定。設定選項在設定文件中指定。

您也可以查看有關我們一些更進階功能的說明文件，例如

下一步匯入現有專案

上次更新時間