electron-egg

name	electron-egg
description	Provides comprehensive guidance for Electron EGG framework including project structure, main/renderer processes, IPC, window management, and desktop app development. Use when the user asks about Electron EGG, needs to create Electron applications with EGG, or work with Electron EGG patterns.
license	Complete terms in LICENSE.txt

When to use this skill

Use this skill whenever the user wants to:

• Install and set up Electron EGG in a project
• Create Electron desktop applications
• Use Electron EGG core features
• Configure Electron EGG
• Handle main process and renderer process communication
• Use Electron EGG API methods
• Build and package Electron applications
• Troubleshoot Electron EGG issues

How to use this skill

This skill is organized to match the Electron EGG official documentation structure (https://www.kaka996.com/, https://www.kaka996.com/pages/987b1c/, https://www.kaka996.com/pages/a99b72/). When working with Electron EGG:

1. Identify the topic from the user's request:

   • Installation/安装 → examples/guide/installation.md
   • Quick Start/快速开始 → examples/guide/quick-start.md
   • Features/功能特性 → examples/features/
   • API/API 文档 → api/

2. Load the appropriate example file from the examples/ directory:

   Guide (使用文档):

   • examples/guide/intro.md - Introduction to Electron EGG
   • examples/guide/installation.md - Installation guide
   • examples/guide/quick-start.md - Quick start guide
   • examples/guide/project-structure.md - Project structure
   • examples/guide/configuration.md - Configuration
   • examples/guide/build.md - Build and package

   Features (功能特性):

   • examples/features/main-process.md - Main process
   • examples/features/renderer-process.md - Renderer process
   • examples/features/ipc-communication.md - IPC communication
   • examples/features/window-management.md - Window management
   • examples/features/menu.md - Menu
   • examples/features/tray.md - System tray
   • examples/features/auto-updater.md - Auto updater
   • examples/features/plugin-system.md - Plugin system

3. Follow the specific instructions in that example file for syntax, structure, and best practices

   Important Notes:

   • Electron EGG is based on Electron and Egg.js
   • Main process and renderer process separation
   • IPC communication between processes
   • Each example file includes key concepts, code examples, and key points

4. Reference API documentation in the api/ directory when needed:

   • api/main-api.md - Main process API
   • api/renderer-api.md - Renderer process API
   • api/ipc-api.md - IPC API
   • api/window-api.md - Window API
   • api/config-api.md - Configuration API

   API Files:

   • api/main-api.md - Application class, BrowserWindow, ipcMain, app methods
   • api/renderer-api.md - ipcRenderer, contextBridge, DOM APIs
   • api/ipc-api.md - IPC communication methods and events
   • api/window-api.md - Window creation and management
   • api/config-api.md - Configuration options and environment variables

5. Use templates from the templates/ directory:

   • templates/installation.md - Installation templates
   • templates/project-setup.md - Project setup templates
   • templates/configuration.md - Configuration templates

1. Understanding Electron EGG

Electron EGG is a desktop application development framework based on Electron and Egg.js, providing a complete development toolchain and best practices.

Key Concepts:

• Electron: Cross-platform desktop application framework
• Egg.js: Node.js enterprise application framework
• Main Process: Main application process
• Renderer Process: UI rendering process
• IPC: Inter-process communication
• Plugin System: Extensible plugin architecture

2. Installation

Using npm:

npm install ee-core

Using yarn:

yarn add ee-core

Using pnpm:

pnpm add ee-core

3. Basic Setup

// main.js
const { Application } = require('ee-core')

const app = new Application({
  // Configuration
})

app.start()

Doc mapping (one-to-one with official documentation)

• examples/ → https://www.kaka996.com/pages/987b1c/
• api/ → https://www.kaka996.com/pages/a99b72/

Examples and Templates

This skill includes detailed examples organized to match the official documentation structure. All examples are in the examples/ directory (see mapping above).

To use examples:

• Identify the topic from the user's request
• Load the appropriate example file from the mapping above
• Follow the instructions, syntax, and best practices in that file
• Adapt the code examples to your specific use case

To use templates:

• Reference templates in templates/ directory for common scaffolding
• Adapt templates to your specific needs and coding style

API Reference

Detailed API documentation is available in the api/ directory, organized to match the official Electron EGG API documentation structure (https://www.kaka996.com/pages/a99b72/):

Main Process API (api/main-api.md)

• Application class and methods
• BrowserWindow creation and management
• ipcMain IPC handling
• Application lifecycle hooks

Renderer Process API (api/renderer-api.md)

• ipcRenderer IPC communication
• contextBridge for secure API exposure
• DOM APIs available in renderer
• Event handling

IPC API (api/ipc-api.md)

• IPC communication methods (ipcMain, ipcRenderer)
• Message sending and receiving
• Async and sync IPC
• Event handling and channels

Window API (api/window-api.md)

• BrowserWindow creation and options
• Window management methods
• Window events
• Window lifecycle

Configuration API (api/config-api.md)

• Configuration file structure
• App info configuration
• Window configuration
• Plugin configuration
• Environment variables

To use API reference:

1. Identify the API you need help with
2. Load the corresponding API file from the api/ directory
3. Find the API signature, parameters, return type, and examples
4. Reference the linked example files for detailed usage patterns
5. All API files include links to relevant example files in the examples/ directory

Best Practices

1. Separate processes: Keep main process and renderer process code separate
2. Use IPC: Use IPC for inter-process communication
3. Handle errors: Properly handle errors in both processes
4. Security: Follow Electron security best practices
5. Performance: Optimize application performance
6. Build configuration: Configure build and package properly
7. Plugin system: Use plugin system for extensibility

Resources

• Official Documentation: https://www.kaka996.com/
• Usage Guide: https://www.kaka996.com/pages/987b1c/
• API Documentation: https://www.kaka996.com/pages/a99b72/
• Gitee Repository: https://gitee.com/dromara/electron-egg

Keywords

Electron EGG, electron-egg, Electron, Egg.js, desktop application, 桌面应用, 主进程, 渲染进程, IPC, 进程间通信, 窗口管理, 菜单, 系统托盘, 自动更新, 插件系统, main process, renderer process, inter-process communication, window management, menu, system tray, auto updater, plugin system

能力边界

✅ 适用场景

• 当你需要使用此技能对应的技术栈时
• 当项目需要遵循最佳实践时
• 当需要快速上手或深入理解核心概念时

⚠️ 需要注意

• 复杂业务逻辑需要结合具体场景调整
• 性能优化需要根据实际数据量评估

❌ 不适用场景

• 不相关的技术栈或框架
• 需要完全自定义的特殊场景

常见陷阱 (Gotchas)

1. 版本兼容性：注意框架版本与依赖库的兼容性，不同版本 API 可能有差异
2. 配置文件格式：配置文件格式错误是最常见的问题，建议使用编辑器的语法检查
3. 环境变量：确保所有必要的环境变量已正确设置，敏感信息不要硬编码
4. 依赖冲突：多版本共存时注意依赖冲突，使用 lock 文件锁定版本
5. 性能陷阱：大数据量场景下注意性能优化，避免 N+1 查询等常见问题

使用流程

Step 1: 环境准备

确保开发环境已安装必要的依赖和工具。

Step 2: 配置初始化

根据项目需求进行基础配置。

Step 3: 核心功能使用

按照示例代码实现核心功能。

Step 4: 测试验证

运行测试确保功能正常。

Step 5: 部署上线

完成开发后进行部署和监控。