63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
# electron-vite-template
|
||
|
||
[Open in Visual Studio Code](https://open.vscode.dev/umbrella22/electron-vite-template/)
|
||
|
||
[](https://github.com/vuejs/vue-next)
|
||
[](https://github.com/vitejs/vite)
|
||
[](https://www.npmjs.org/package/element-plus)
|
||
[](https://github.com/electron/electron)
|
||
[](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 18** 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)
|
||
|
||
[](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**
|