# electron-egg

**Repository Path**: dromara/electron-egg

## Basic Information

- **Project Name**: electron-egg
- **Description**: 一个入门简单、跨平台、企业级桌面软件开发框架。
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.kaka996.com/
- **GVP Project**: Yes

## Statistics

- **Stars**: 6046
- **Forks**: 1665
- **Created**: 2020-11-02
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: desktop-ui

**Tags**: Nodejs, Vue, Electron, electron-egg

## README

[![star](https://gitee.com/dromara/electron-egg/badge/star.svg?theme=gvp)](https://gitee.com/dromara/electron-egg/stargazers)
[![GitHub](https://img.shields.io/github/stars/dromara/electron-egg.svg?style=social&label=Stars)](https://github.com/dromara/electron-egg)
[![Star](https://gitcode.com/dromara/electron-egg/star/badge.svg)](https://gitcode.com/dromara/electron-egg)
[![License](https://img.shields.io/badge/License-Apache-blue.svg)](https://gitee.com/dromara/electron-egg/blob/master/LICENSE)

<div align=center>
<h3>🎉🎉🎉 ElectronEgg v4 已发布! 🎉🎉🎉</h3>
</div>
<br>

<div align=center>
<img src="./public/images/example/logo.png" width="150" height="150" />
</div>

<div align=center>
<h3><strong>一个入门简单、跨平台、企业级桌面软件开发框架</strong></h3>
</div>
<br>

<!-- ## 🌏 [English](https://www.yuque.com/u34495/ee-doc) | [中文](https://www.kaka996.com/) -->

## 📋 介绍

> 框架已经广泛应用于记账、政务、企业、医疗、学校、股票交易、ERP、娱乐、视频等领域客户端，请放心使用！

## 👦 谁可以使用

项目已经有 5 个交流群，覆盖`前端`、`java`、`go`、`python`、`php` 等开发者。

无论你是前端、服务端、运维、游戏、客户端等，都可以很快入门，

## 🐶 精彩案例

- [**点击查看**](#项目案例)

## 📺 特点
- 🍩 **为什么使用？** 桌面软件（办公方向、 个人工具），仍然是未来十几年PC端需求之一，提高工作效率
- 🍉 **简单：** 支持 js、ts 
- 🍑 **愿景：** 所有开发者都能学会桌面软件研发
- 🍰 **gitee：** https://gitee.com/dromara/electron-egg **5900+**
- 🍨 **github：** https://github.com/dromara/electron-egg **2500+**
- 🍰 **gitcode：** https://gitcode.com/dromara/electron-egg 
- 🏆 码云最有价值开源项目
    ![](./public/images/example/ee-zs.png)  
    ![](./public/images/example/ee-zs2.jpg)  

## 📚 文档
- 快速体验：[教程文档](https://www.kaka996.com/)
    ![](./public/images/example/v3-home.png) 

## 📦 特性
1. 🍄 跨平台：一套代码，可以打包成windows版、Mac版、Linux版、国产UOS、Deepin、麒麟等
2. 🌹 架构：单业务进程/模块化/多任务(进程，线程，渲染进程)，让开发大型项目变的简单。
3. 🌱 简单高效：支持 js、ts 
4. 🌴 前端独立：理论上支持任何前端技术，如：vue、react、html等等
5. 🍁 工程化：可以用前端、服务端的开发思维，来编写桌面软件
6. 🌷 高性能：事件驱动、非阻塞式IO
7. 🌰 功能丰富：配置、通信、插件、数据库、升级、打包、工具... 应有尽有
8. 💐 安全：支持字节码加密、压缩混淆加密
9. 🌻 功能demo：桌面软件常见功能，框架集成或提供demo

## ✈️ 使用场景

### 1. 🚀 常规桌面软件
- 🚖 windows平台

    ![](./public/images/example/ee-win-home.png)

- 🚍 macOS平台    
    ![](./public/images/example/ee-mac-home.png)

- 🚔 linux平台 - 国产UOS、Deepin
    ![](./public/images/example/uos-home.png)

- 🚔 linux平台 - ubuntu
    ![](./public/images/example/ubuntu-db.png)

### 🚐 2. vue、react、angular、web 转换成桌面软件
- 🚙 vue-ant-design（本地）

    ![](./public/images/example/vue-antd.png)

- 🚙 禅道项目管理（web项目地址）

    ![](./public/images/example/ee-project-7.png)

### 🚂 3. 游戏（h5相关技术开发）
- 🚊 忍者100层

    ![](./public/images/example/ee_game_1.png)


## 📒 开始使用

- ✒️ [安装文档](https://www.kaka996.com/pages/e64ff6/)
    
## 项目案例
- 🐟 框架已经应用于医疗、学校、政务、股票交易、ERP、娱乐、视频、企业等领域客户端

### 🐸 知识笔记

- [概言](https://gaiyan.net?from=electron-egg) 
![](./public/images/example/gaiyan-1.jpg)
![](./public/images/example/gaiyan-2.png)

### 🐸 远控

- RQ Center
![](./public/images/example/rq-1.png)
![](./public/images/example/rq-2.png)

### 🐸 云盘

- FM Cloud
![](./public/images/example/fm-p2.png)
![](./public/images/example/fm-p1.png)
![](./public/images/example/fm-p4.png)

### 🐸 IM

- Cede IM
![](./public/images/example/im-p1.png)
![](./public/images/example/im-p5.png)
![](./public/images/example/im-p1.png)

### 🐸 壁纸

- warpar
![](./public/images/example/aw-3.png)

### 🐸 英雄联盟助手

- Serendlplty
![](./public/images/example/lol-zhanji.png)

### 🐸 更多

- [更多案例](https://www.kaka996.com/pages/eadf46/)

## 💬 交流
1. [讨论](https://www.kaka996.com/pages/c2720e/)

## 📌 关于pr
请前往[GitHub项目](https://github.com/dromara/electron-egg)提pr（避免代码同步后，pr被覆盖掉），感谢！

地址：https://github.com/dromara/electron-egg

## 📔 框架核心包 ee-core
ee-core：[https://github.com/wallace5303/ee-core](https://github.com/wallace5303/ee-core)