electron-egg electron-egg
首页
  • v4.x
  • v3.x
  • v2.x
插件
  • v4.x
  • v3.x
demo
支持
知识点
案例
交流
  • GitHub (opens new window)
  • Gitee (opens new window)
首页
  • v4.x
  • v3.x
  • v2.x
插件
  • v4.x
  • v3.x
demo
支持
知识点
案例
交流
  • GitHub (opens new window)
  • Gitee (opens new window)
❤️成为赞助商
  • 快速入门

    • 介绍
    • EE框架是什么?
    • 安装
    • 第三方使用
    • 快速开始
      • 配置

      • 命令
    • 基础功能

    • 生成软件

    • 升级

    • 跨语言支持

    • 更新记录
    • 常见问题
    目录

    快速开始

    # 框架架构

    # v3 版本

    单业务进程 + 模块化 + 多任务,适合小/中/大项目,兼顾开发效率 和 后期维护,兼容v2版本。

    # 进程

    框架有三种进程

    • ee主进程:业务逻辑
    • ee渲染进程:软件界面UI
    • ee任务进程:耗时业务

    # 通信

    • ipc:前端 ⇋ 业务层 (双向通信)
    • http: 前端、命令行、浏览器 ⇋ 业务层 (单向通信)
    • socket:前端 ⇋ 业务层 (双向通信)

    # 本地存储

    • json数据库
    • sqlite数据库

    # 核心包

    ee-bin 提供命令行工具,开发环境使用。

    ee-core 提供框架核心功能。

    ee-go (可选) 提供 go 语言支持。

    # 功能划分

    # 软件界面

    frontend 目录,开发软件界面;支持任意前端技术,如vue、react、angular、html、vite 等

    # 业务逻辑

    electron 目录,开发业务逻辑;常规业务逻辑、调用操作系统api、访问远程服务器api等

    go 目录(可选),开发业务逻辑;利用go的跨平台、高性能,大幅提升软件体验。

    # 开发者模式

    # 安装依赖

    # 根目录,安装 electron 依赖
    npm i
    
    # 进入【前端目录】安装 frontend 依赖
    cd frontend 
    npm i
    

    # 启动方式一

    ee-bin: v1.2.0

    ee-core: v2.5.0

    新版本可同时启动 前端 & 主进程,也可以分开启动。

    electron业务代码暂不支持热更(修改代码后需重新启动),如果前端启动时间长,则建议分开启动。

    注意

    第一次启动时,窗口弹窗稍慢,同时会加载一个 loading 页面(仅dev环境),请耐心等待。

    配置 package.json

      "scripts": {
        "dev": "ee-bin dev",
        "dev-frontend": "ee-bin dev --serve=frontend",
        "dev-electron": "ee-bin dev --serve=electron",
        "start": "ee-bin start",
        "build-frontend": "ee-bin build",
      }
    
    • 同时启动 frontend (UI) 、electron 两个服务。
    npm run dev
    
    • 分开启动 frontend (UI) 、electron
    # 打开两个终端
    npm run dev-frontend
    
    npm run dev-electron
    
    • 构建前端资源。
    npm run build-frontend
    

    提示

    注:如果启动的前端服务不是:http://localhost:8080/ 请先配置:config/bin.js 文件中的 frontend 对象

    # 启动方式二

    旧版本使用,功能受限,请升级ee-bin和ee-core,并添加 ./electron/config/bin.js 配置文件。

    package.json

      "scripts": {
        "dev": "electron . --env=local",
        "start": "electron . ",
      }
    
    1. 启动前端
    # 进入【前端目录】
    cd frontend 
    
    # 安装依赖
    npm install
    
    # 启动
    npm run dev
    # npm run serve (old)
    

    提示

    注:如果启动的前端服务不是:http://localhost:8080/ 请先配置:config 文件中的 开发模式

    1. 启动主进程
    # 项目【根目录】
    npm run dev
    
    # 热重载模式
    npm run reload
    

    # Demo

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

    # 生成软件

    见教程:构建可执行程序

    上次更新: 2025/06/06, 07:21:49
    第三方使用
    基础

    ← 第三方使用 基础→

    Theme by Vdoing | Copyright © 2023-2025 哆啦好梦 | 京ICP备15041380号-2
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式
    ×