# electron-vite-template

**Repository Path**: Zh-Sky/electron-vite-template

## Basic Information

- **Project Name**: electron-vite-template
- **Description**: 基于vite+electron LTS的模板，借助electron next的新特性和vite以及rollup的速度，可以让您能够快速开发
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: mini-main
- **Homepage**: https://zh-sky.gitee.io/electron-vue-template-doc/
- **GVP Project**: No

## Statistics

- **Stars**: 312
- **Forks**: 120
- **Created**: 2021-02-26
- **Last Updated**: 2025-09-08

## Categories & Tags

**Categories**: desktop-ui

**Tags**: Electron, TypeScript, vite, vue3

## README

# electron-vite-template

![GitHub Repo stars](https://img.shields.io/github/stars/umbrella22/electron-vite-template)
[![vue](https://img.shields.io/badge/vue-3.5.16-brightgreen.svg)](https://github.com/vuejs/vue-next)
[![vite](https://img.shields.io/badge/vite-6.3.5-brightgreen.svg)](https://github.com/vitejs/vite)
[![element-ui](https://img.shields.io/badge/element-plus-brightgreen.svg)](https://www.npmjs.org/package/element-plus)
[![electron](https://img.shields.io/badge/electron-34.5.8-brightgreen.svg)](https://github.com/electron/electron)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/umbrella22/electron-vite-template/blob/master/LICENSE)

# Installation

You can choose to clone the project or fork repository, or download the zip file directly. It is recommended to clone the repository so that you can receive the latest patches.

To run a project, you need to have **node version 20** or higher and **use npm as your dependency management tool**

[Document (Chinese only)](https://umbrella22.github.io/electron-vue-template-doc/)

[For Chinese Developers](/README_ZH.md)

[![Build TEST](https://github.com/umbrella22/electron-vite-template/actions/workflows/Build.yml/badge.svg)](https://github.com/umbrella22/electron-vite-template/actions/workflows/Build.yml)

# Build Setup

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

# serve with hot reload at localhost:9080
$ npm run dev

# build electron application for production
$ npm run build


```

---

# Function list

[x] Auto update
[x] Incremental update
[x] Loading animation before startup
[x] i18n

# Built-in

- [vue-router](https://next.router.vuejs.org/index.html)
- [pinia](https://pinia.esm.dev/)
- [electron](http://www.electronjs.org/docs)
- electron-updater
- typescript

# Note

- [gitee](https://gitee.com/Zh-Sky/electron-vite-template) is only for domestic users to pull code，from github to synchronize，please visit github for PR
- **Welcome to Issues and PR**