准备

• 推荐 node.js >= 16.20.0
• 框架版本 与 electron/node.js 版本不是强绑定的，可升级/降低 electron/node.js版本。
• node.js 安装教程

注意

请使用 npm，不推荐 yarn、cnpm、pnpm ，可能会出现依赖问题。

有问题先看文档：常见问题

下载

# gitee
git clone https://gitee.com/dromara/electron-egg.git

# github
git clone https://github.com/dromara/electron-egg.git

安装

# 进入目录 ./electron-egg/
npm install

# 如果还是提示 electron 没安装，进入 node_modules/electron 目录下，再npm install

# 解决幽灵依赖，在 .npmrc 文件中添加如下内容:
node-linker=hoisted 

# 进入目录 ./electron-egg/
pnpm install

// Make sure to add code blocks to your code group

如果下载慢：设置国内镜像源(加速)

在根目录添加 .npmrc 文件，添加如下内容

registry=https://registry.npmmirror.com/
disturl=https://registry.npmmirror.com/-/binary/node
electron_mirror=https://npmmirror.com/mirrors/electron/
electron-builder-binaries_mirror=https://registry.npmmirror.com/-/binary/electron-builder-binaries/

运行项目

查看教程：快速开始

生成软件

查看教程：构建可执行程序

Demo

框架集成了许多功能demo示例，方便开发者快速入门。查看demo文档

window 7 系统

微软已经停止对 win7系统支持。如果希望app能够在win7上运行，请使用以下软件/库版本，开发环境不限:

注：不用降级框架版本

electron <= v21.4.4
node.js <= v16.20.2
electron-builder <= v23.6.0
（可选）@types/node <= v16.18.12 类型提示
（可选）better-sqlite3 <= v8.6.0 

框架长期使用的历史版本

如果你不了解 node.js 与 electron 的依赖关系，请使用如下版本。

node.js: v20.16.0 
electron: v^31.7.6
better-sqlite3: v11.7.0

node.js: v16.20.0 
electron: v21.4.4 
better-sqlite3: v8.6.0 

node.js: v14.21.1
electron: v13.6.9
better-sqlite3: v7.6.0 

node.js: v12.22.0
electron: v12.2.3 
better-sqlite3: v7.6.0