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
electron-egg
Using yarn
:
yarn
add
electron-egg
Using pnpm
:
pnpm
add
electron-egg
3. Basic Setup
// main.js
const
{
Application
}
=
require
(
'electron-egg'
)
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:
Identify the API you need help with
Load the corresponding API file from the
api/
directory
Find the API signature, parameters, return type, and examples
Reference the linked example files for detailed usage patterns
All API files include links to relevant example files in the
examples/
directory
Best Practices
Separate processes
Keep main process and renderer process code separate
Use IPC
Use IPC for inter-process communication
Handle errors
Properly handle errors in both processes
Security
Follow Electron security best practices
Performance
Optimize application performance
Build configuration
Configure build and package properly
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