Clone and run for a quick way to see Electron in action.

This is a minimal Electron application based on the ​​Quick Start Guide​​ within the Electron documentation.

A basic Electron application needs just these files:

  • ​​package.json​​ - Points to the app's main file and lists its details and dependencies.
  • ​​main.js​​ - Starts the app and creates a browser window to render HTML. This is the app'smain process.
  • ​​index.html​​ - A web page to render. This is the app'srenderer process.

You can learn more about each of these components within the ​​Quick Start Guide​​.

To Use

To clone and run this repository you'll need ​​Git​​ and ​​Node.js​​ (which comes with ​​npm​​) installed on your computer. From your command line:

# Clone this repository
git clone https://github.com/electron/electron-quick-start
# Go into the repository
cd electron-quick-start
# Install dependencies
npm install
# Run the app
npm start

Note: If you're using Linux Bash for Windows, ​​see this guide​​ or use ​​node​​ from the command prompt.

Build

最快捷的打包方式是使用 ​​Electron Forge​​。

将 Electron Forge 添加到您应用的开发依赖中，并使用其"import"命令设置 Forge 的脚手架：

npm install --save-dev @electron-forge/cli
npx electron-forge import

使用 Forge 的 ​​make​​ 命令来创建可分发的应用程序：

npm run make

Electron-forge 会创建 ​​out​​ 文件夹

打包的配置信息package.json：

{
  ...
 "config": {
    "forge": {
      "packagerConfig": {
        "icon": "favicon.ico"                    //安装包图标
      },
      "makers": [
        {
          "name": "@electron-forge/maker-squirrel",
          "config": {
            "name": "AppName",                //程序名
            "setupExe":"setup.exe",
            "setupMsi":"setup.msi",
            "setupIcon":"favicon.ico",         //快捷方式图标
            "version":"1.0.1"
          }
        },
        {
          "name": "@electron-forge/maker-zip",
          "platforms": [
            "darwin"
          ]
        },
        {
          "name": "@electron-forge/maker-deb",
          "config": {}
        },
        {
          "name": "@electron-forge/maker-rpm",
          "config": {}
        }
      ]
    }
  }
}