Prerequisites

• Recommended node.js >= 20.20.2

Note

Please use npm. yarn, cnpm, and pnpm are not recommended as they may cause dependency issues.

If you encounter problems, check the documentation first: FAQ

Download

# gitee
git clone https://gitee.com/dromara/electron-egg.git

# github
git clone https://github.com/dromara/electron-egg.git

Install

If download is slow: set a domestic mirror source (acceleration)

Add a .npmrc file in the root directory with the following content:

registry=https://registry.npmmirror.com/
disturl=https://registry.npmmirror.com/-/binary/node
electron_mirror=https://npmmirror.com/mirrors/electron/
electron-builder-binaries_mirror=https://registry.npmmirror.com/-/binary/electron-builder-binaries/

Run the Project

See tutorial: Quick Start

Build Software

See tutorial: Build Executable Program

Demo

The framework integrates many feature demo examples for developers to quickly get started. See demo documentation

Windows 7

Framework v5 no longer supports Windows 7. If needed, please use the v4 version.