Skip to content

About

This project is a vue3 + Vite + electron project template composed of Vite and rollup. It has the same functions as my previous electron+Vue+template project

Topics

Resources

Stars

515 stars

Watchers

4 watching

Forks

Repository files navigation

electron-vite-template

GitHub Repo stars electron vue node pnpm license Build TEST

A pnpm monorepo Electron + Vue 3 desktop application template — domain-grouped typed IPC, contextBridge security model, and optional V8 bytecode protection, all out of the box.

Documentation

📘 Documentation (Chinese only)

The docs cover everything: getting started, the IPC contract system, the security model, build & packaging, hot update, bytecode protection, and CI workflows.

Requirements

  • Node.js ≥ 24 — build scripts run on Node's native TypeScript support
  • pnpm — the only package manager used (corepack enable aligns the version via the packageManager field)

Build Setup

# Clone this repository
$ git clone https://github.com/umbrella22/electron-vite-template.git
# Go into the repository
$ cd electron-vite-template
# Install dependencies
$ pnpm install

# Start development (hot reload at localhost:9080)
$ pnpm dev

# Build and package for the current platform
$ pnpm run build

# Build without generating an installer (fast packaging check)
$ pnpm run build:dir

Feature list

  • Typed domain-grouped IPC (app:openWin, browser:selectTab, ...) with compile-time safety
  • contextIsolation + sandbox security model with a whitelisted preload bridge
  • Auto update (electron-updater)
  • Incremental hot update (renderer + main process content)
  • Optional main-process bytecode protection (opt-in, zero toolchain)
  • vp run cached build pipeline & 3-platform CI workflows
  • i18n

Built-in

Note

  • gitee is only for domestic users to pull code; it is synced from GitHub — please visit GitHub for PRs
  • Welcome to Issues and PR

About

This project is a vue3 + Vite + electron project template composed of Vite and rollup. It has the same functions as my previous electron+Vue+template project

Topics

Resources

Stars

515 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages