Skip to content

This tutorial introduces the business feature demos. The goal is to help developers quickly become familiar with the electron-egg framework and understand common desktop application features.

Download and Try

Windows: Gitee DownloadGitHub Download

macOS: Gitee DownloadGitHub Download

Categories

Framework: Provides demos for using framework APIs

Operating System: Provides demos for common desktop application features

Hardware: Provides demos for connecting to hardware devices

Effects: Provides demos for implementing software visual effects

Branch Descriptions

  • master Main branch (current v5)
  • demo Feature example branch, TypeScript version (current v5)
  • demo_js Feature example branch, JavaScript version (current v5)
  • demo_v4_js Feature example branch, JavaScript version (no longer maintained)
  • demo_v4_ts Feature example branch, TypeScript version (no longer maintained)
  • dev_v5 electron-egg v5 development branch, TypeScript version
  • dev_v5_js electron-egg v5 development branch, JavaScript version
  • dev_v4 electron-egg v4 development branch (no longer maintained)
  • dev_v3 electron-egg v3 development branch (no longer maintained)
  • master_v2 electron-egg v2 main branch (no longer maintained)
  • Other branches can be ignored

How to Run

  1. Clone the project
bash
# gitee
git clone https://gitee.com/dromara/electron-egg.git

# github
git clone https://github.com/dromara/electron-egg.git
  1. Checkout the demo branch and switch to it
bash
git checkout -b demo remotes/origin/demo
  1. Install dependencies and start

The database portion in the demo may cause errors. Please install the better-sqlite3 package. See the better-sqlite3 installation tutorial

To start, see the documentation: Quick Start Developer Mode

Note

As the number of demos grows, many third-party modules have inevitably been installed. Therefore, a separate demo branch has been created to showcase the features.

The main branch only retains the essential dependencies.