hi-sass-frame/README_ZH.md

51 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Hi-Sass-Frame
[![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)
---
### 请确保您的 node 版本大于等于 18.
- vue3.*等版本要求node.js版本高于18
#### 如何安装
- 推荐使用yarn安装我开发过程用的是yarn来管理包
```bash
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
```
---
# 关于开发修改的一些前置说明
- 本框架示范了集成多个自定义主题(themes/目录),但实际应只需要一个就可以的。因此,根据自己的项目调整,保留一个合适,再在其基础上优化,就可以了。
- 调整自定义主题涉及到多处配置文件的修改主要是tsconfig.json中的路径别名与vite.config.mts中的路径别名。
- 另外如果需要兼顾web端的话建议在web端也对路径及别名做相应的调整实现一处开发、两处可用。主旨就是 web端的开发让项目文件夹目录级别保持与本electron框架的目录级别一致然后调整相应的路径别名引用
---
# [文件目录说明](DIR.md)
# [更新日志](./CHANGELOG.md)