# electron-vite-template

**Repository Path**: mr-xiaoyu/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**: main
- **Homepage**: https://zh-sky.gitee.io/electron-vue-template-doc/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 120
- **Created**: 2022-03-02
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# electron-vite-template

[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/umbrella22/electron-vite-template)
![GitHub Repo stars](https://img.shields.io/github/stars/umbrella22/electron-vite-template)
[![vue](https://img.shields.io/badge/vue-3.2.30-brightgreen.svg)](https://github.com/vuejs/vue-next)
[![vite](https://img.shields.io/badge/vite-2.8.1-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-15.3.2-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 16** or higher and **use yarn as your dependency management tool**

[For Chinese Developers](/README_ZH.md)

[![Build Updater Status](https://github.com/umbrella22/electron-vite-template/actions/workflows/Build%20Update.yml/badge.svg)](https://github.com/umbrella22/electron-vite-template/actions/workflows/Build%20Update.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
$ yarn install

# serve with hot reload at localhost:9080
$ yarn dev

# build electron application for production
$ yarn build


```

---

# Function list

- Auto update
- Incremental update
- Loading animation before startup
- i18n
- Incremental update (wait for test)

# 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
- [element-plus](https://element-plus.gitee.io/#/en-US/component/installation)

# 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**