# 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**: 6058
- **Forks**: 1667
- **Created**: 2020-11-02
- **Last Updated**: 2026-06-30

## 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 V5 Has Been Released! 🎉🎉🎉</h3>
</div>
<br>

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

<div align=center>
<h3><strong>An easy-to-learn, cross-platform, enterprise-grade desktop software development framework</strong></h3>
</div>
<br>

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

## 📋 Introduction

> The framework has been widely used in accounting, government, enterprise, healthcare, education, stock trading, ERP, entertainment, video, and other desktop application domains — feel confident using it!

## 👦 Who Can Use It

The project already has 5 community groups covering `frontend`, `Java`, `Go`, `Python`, `PHP`, and other developers.

Whether you are a frontend, backend, DevOps, game, or client developer, you can get started quickly.

## 🐶 Showcase

- [**Click to view**](#project-cases)

## 📺 Features
- 🍩 **Why use it?** Desktop software (office & personal tools) will remain one of the PC demands for the next decade, boosting work efficiency
- 🍉 **Simple:** Supports JS, TS, CJS, ESM
- 🍑 **Vision:** All developers can learn desktop software development
- 🍰 **Gitee:** https://gitee.com/dromara/electron-egg **6000+**
- 🍨 **GitHub:** https://github.com/dromara/electron-egg **2400+**
- 🏆 Gitee Most Valuable Open Source Project
    ![](./public/images/example/ee-zs.png)

## 📚 Documentation
- Quick start: [Tutorial Docs](https://www.kaka996.com/)
    ![](./public/images/example/v3-home.png)

## 📦 Highlights
1. 🍄 Cross-platform: One codebase can be packaged for Windows, macOS, Linux, national UOS, Deepin, Kylin, etc.
2. 🌹 Architecture: Single business process / modular / multi-task (process, thread, renderer process), making large-scale project development simple.
3. 🌱 Simple & efficient: Only need to learn JS
4. 🌴 Frontend-independent: Theoretically supports any frontend technology, such as Vue, React, HTML, etc.
5. 🍁 Engineering: You can write desktop software using frontend and backend development paradigms
6. 🌷 High performance: Event-driven, non-blocking I/O
7. 🌰 Feature-rich: Configuration, communication, plugins, database, upgrades, packaging, tools... everything you need
8. 💐 Security: Supports bytecode encryption and compression/obfuscation encryption
9. 🌻 Feature demos: Common desktop software features are integrated or provided as demos in the framework

## ✈️ Use Cases

### 1. 🚀 Conventional Desktop Software
- 🚖 Windows platform

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

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

- 🚔 Linux platform - National UOS, Deepin
    ![](./public/images/example/uos-home.png)

- 🚔 Linux platform - Ubuntu
    ![](./public/images/example/ubuntu-db.png)

### 🚐 2. Convert Vue, React, Angular, and Web apps into Desktop Software
- 🚙 Vue Ant Design (local)

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

- 🚙 Zentao Project Management (web project URL)

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

### 🚂 3. Games (developed with H5-related technologies)
- 🚊 Ninja 100 Floors

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


## 📒 Getting Started

- ✒️ [Installation Guide](https://www.kaka996.com/pages/e64ff6/)

## Project Cases
- 🐟 The framework has been applied to desktop clients in healthcare, education, government, stock trading, ERP, entertainment, video, enterprise, and other domains

### 🐸 Remote Control

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

### 🐸 Cloud Storage

- 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)

### 🐸 Wallpaper

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

### 🐸 League of Legends Assistant

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

### 🐸 More

- [More Cases](https://www.kaka996.com/pages/eadf46/)

## 💬 Community
1. [Discussion](https://www.kaka996.com/pages/c2720e/)