fm453/hi-sass-frame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

修改了说明文件

Browse Source
This commit is contained in:
fm453 2024-09-09 10:24:48 +08:00
parent 260f033ee3
commit 82f452193f
2 changed files with 53 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
README.md
View File

@ -1,62 +1,44 @@
# electron-vite-template
# Hi-Sass-Frame
[Open in Visual Studio Code](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.4.21-brightgreen.svg)](https://github.com/vuejs/vue-next)
[![vite](https://img.shields.io/badge/vite-5.2.7-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-29.1.6-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)
[![vue](https://img.shields.io/badge/vue-3.4.21-brightgreen.svg)](https://cn.vuejs.org/guide/quick-start)
[![vite](https://img.shields.io/badge/vite-5.4.1-brightgreen.svg)](https://www.vitejs.net/guide/)
[![element-ui](https://img.shields.io/badge/element-plus-brightgreen.svg)](https://cn.element-plus.org/zh-CN/)
[![electron](https://img.shields.io/badge/electron-32.0.1-brightgreen.svg)](https://www.electronjs.org/zh/docs/latest/tutorial/quick-start)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://gitea.hiluker.com/fm453/hi-sass-frame/src/branch/main/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)
[![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
---
### 请确保您的 node 版本大于等于 18.
- vue3.*等版本，要求node.js版本高于18
#### 如何安装
- 推荐使用yarn安装（我开发过程用的是yarn来管理包）
```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
yarn
#或者
yarn add
```
- 如果你要用npm，可参考下方，使用淘宝镜像源，速度可能会快一些）
```bash
npm config edit
# 该命令会打开npm的配置文件，请在空白处添加
# registry=https://registry.npmmirror.com
# ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
# ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
# 然后关闭该窗口，重启命令行.
npm install
```
# 运行脚本
```bash
# 启动之后，会在9080端口监听
npm run dev
# build命令在不同系统环境中，需要的的不一样，需要自己根据自身环境进行配置
# 具体可在package.json中查阅
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**
# [文件目录说明](DIR.md)
# [更新日志](./CHANGELOG.md)

31
README_ZH.md
View File

@ -1,19 +1,24 @@
# Electron-Vite-template
# Hi-Sass-Frame
![GitHub Repo stars](https://img.shields.io/github/stars/umbrella22/electron-vite-template)
[![vue](https://img.shields.io/badge/vue-3.2.23-brightgreen.svg)](https://github.com/vuejs/vue-next)
[![vite](https://img.shields.io/badge/vite-3.0.3-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-19.0.4-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)
[![vue](https://img.shields.io/badge/vue-3.4.21-brightgreen.svg)](https://cn.vuejs.org/guide/quick-start)
[![vite](https://img.shields.io/badge/vite-5.4.1-brightgreen.svg)](https://www.vitejs.net/guide/)
[![element-ui](https://img.shields.io/badge/element-plus-brightgreen.svg)](https://cn.element-plus.org/zh-CN/)
[![electron](https://img.shields.io/badge/electron-32.0.1-brightgreen.svg)](https://www.electronjs.org/zh/docs/latest/tutorial/quick-start)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://gitea.hiluker.com/fm453/hi-sass-frame/src/branch/main/LICENSE)
[国内访问地址](https://gitee.com/Zh-Sky/electron-vite-template)
---
### 请确保您的 node 版本大于等于 16.
### 请确保您的 node 版本大于等于 18.
- vue3.*等版本，要求node.js版本高于18
#### 如何安装
- 推荐使用yarn安装（我开发过程用的是yarn来管理包）
```bash
yarn
#或者
yarn add
```
- 如果你要用npm，可参考下方，使用淘宝镜像源，速度可能会快一些）
```bash
npm config edit
# 该命令会打开npm的配置文件，请在空白处添加
@ -21,13 +26,15 @@ npm config edit
# ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
# ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/
# 然后关闭该窗口，重启命令行.
# 使用yarn安装
npm install
```
# 运行脚本
```bash
# 启动之后，会在9080端口监听
npm run dev
# build命令在不同系统环境中，需要的的不一样，需要自己根据自身环境进行配置
# 具体可在package.json中查阅
npm run build
```