haokur/electron-starter

electron初始化项目

一、初始化

1. 下载官方代码：

electron/electron-quick-start: Clone to try a simple Electron app (github.com)

2. 修改 .npmrc，加速 electron 下载

package-lock=true
registry=https://registry.npmmirror.com/
electron_mirror=https://npmmirror.com/mirrors/electron/

3. 启动

npm start

4. 打包

npm run build

二、使用 vite 和 ts

注意点:

• main 和 renderer 包下各一个 ts.config.ts,因为要打包后的结果不一样
• 打包时,生成的目录为 build/main 和 build/renderer
• package.json 中配置的入口(main)为 build/main/main.js
• npm run build, 会先根据根目录 vite.config.js 打包renderer 应用,然后再执行 electron-builder 打包

三、版本更新

1. 安装依赖项:

npm install electron-builder --save-dev

2. 配置远程最新软件包服务器地址

electron-builder.json 中

"publish": [
    {
        "provider": "generic",
        // "url": "https://static.haokur.com/electron-app/"
    }
]

3. 打包:

npm run build

4. 在 dist 目录下, 若是 mac 环境则将

-- dist ---- latest-mac.yml ---- electron-starter-1.0.1-mac.zip ---- electron-starter-1.0.1.dmg

以上三个文件,放到服务器如 https://static.haokur.com/electron-app/ 的目录下

5. 更改 package.json 里的 version 来生成一个版本号,要测更新,则改一个比服务器的低版本
6. 打包完后,打开应用,则会提示更新

四、优化

node_modules 依赖优化

1. dist/mac 下的包查看包内容
2. 安装 asar

npm install asar -g

3. 解压 app.asar

asar extract app.asar ./app

4. 查看目录下的 node_modules 文件夹
5. 打包时,会把 package.json 下的 dependencies 里配置的依赖都打包进去
6. 将 renderer 的依赖都移到 devDependencies 中, 因为 renderer 使用 vite 打包,会合并 node_modules 里代码
7. 可在根目录下,electron-builder.json 中的 files 选项,添加忽略项