Skip to content

Commit

Permalink
🎨 文档更新
Browse files Browse the repository at this point in the history
  • Loading branch information
HibiKier committed Oct 7, 2024
1 parent 7daaae7 commit e6ba8c4
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 102 deletions.
135 changes: 33 additions & 102 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,118 +1,49 @@
# hi~这里是小真寻的webui捏
### 欢迎使用小真寻的webui,这里介绍一下简易的部署方法
<div align=center><img width="320" height="320" src="https://raw.githubusercontent.com/HibiKier/zhenxun_bot/main/logo.png"/></div>
<div align=center>

![maven](https://img.shields.io/badge/Vue-2.6.14-blue)
<img width="250" height="312" src="https://github.com/HibiKier/nonebot-plugin-zxpm/blob/main/docs_image/tt.jpg"/>

## 开发环境使用方式(请先进入webui根目录文件夹下再使用命令)
</div>

****
### 开发环境说明:
### &ensp; &ensp; 开发环境用于修改和测试源码,启动开发服务会占用一定的资源和性能
****
### 部署准备:
### &ensp; &ensp; 开发环境需要下载nodejs,未安装请移步链接 https://nodejs.org/zh-cn/download/
****
<div align="center">

# zhenxun_bot_webui

## 使用npm(nodejs自带)
_✨ 这是 [绪山真寻Bot](https://github.com/HibiKier/zhenxun_bot) 可视化前端 ✨_

### 下载webui开发依赖
<!-- ![python](https://img.shields.io/badge/python-v3.9%2B-blue)
![nonebot](https://img.shields.io/badge/nonebot-v2.1.3-yellow)
![onebot](https://img.shields.io/badge/onebot-v11-black) -->
[![license](https://img.shields.io/badge/license-AGPL3.0-FE7D37)](https://github.com/HibiKier/zhenxun_bot_webui/blob/main/LICENSE)

```
npm install
```
</div>

### 启动开发服务
```
npm run serve
```
## 📖 介绍

### 打包生产环境资源
```
npm run build
```
这是可爱的 [小真寻](https://github.com/HibiKier/zhenxun_bot) 的的可视化前端实现

## 使用yarn(需要下载)
> [!NOTE]
>
> <div align="center"><b>小真寻也很可爱呀,也会很喜欢你!</b></div>
>
> <div align="center"><img width="250" height="250" src="https://github.com/HibiKier/nonebot-plugin-zxpm/blob/main/docs_image/tt3.png"/><img width="250" height="250" src="https://github.com/HibiKier/nonebot-plugin-zxpm/blob/main/docs_image/tt1.png"/><img width="250" height="250" src="https://github.com/HibiKier/nonebot-plugin-zxpm/blob/main/docs_image/tt2.png"/></div>
### 使用npm安装yarn
## 💿 安装

```
npm install --global yarn
```
> [!IMPORTANT]
> 当前真寻已内置webui,无需额外安装
> 其他安装请查看 [文档](https://hibikier.github.io/zhenxun_bot/install/webui/install-webui-default)
### 下载webui开发依赖
## 🎁 后台图

```
yarn install
```
<div align="center">

### 启动开发服务
```
yarn serve
```
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/0.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/1.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/2.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/3.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/4.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/5.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/6.png)
![x](https://raw.githubusercontent.com/HibiKier/zhenxun_bot_webui/main/docs_image/7.png)

### 打包生产环境资源
```
yarn build
```


## 生产环境使用方式
****
### 生产环境说明:
### &ensp; &ensp; 生产环境用于webui的日常使用场景,更新只需要覆盖打包的资源即可
### &ensp; &ensp; 生产环境的部署方式很多,这里使用nginx示例

****
### 部署准备:
### &ensp; &ensp; 下载nginx并安装,移步 http://nginx.org/en/download.html
### &ensp; &ensp; 下载webui最新releas或者使用源码中的dist文件夹资源

****
### 简易部署

#### 把下载好的webui资源(css/js/html)复制到nginx根目录下的html文件夹,复制前可先删除html文件夹原有的html文件。
* window环境下进入解压后的nginx根目录点击nginx.exe即可启动
* linux环境下进入编译安装后的nginx根目录下输入
```
./sbin/nginx
```


#### nginx启动成功后打开浏览器,输入链接
```
localhost
```

****



## 更新

### 2022/6/20 \[v0.1.0.4]
* 优化普通插件列表在低宽度屏幕下的体验

### 2022/6/18

* 修复cookie储存异常的问题
* 侧边栏在低分辨率屏幕下自动隐藏

### 2022/6/5 \[v0.1.0.3] (__务必使用zhenxun_bot_v0.1.5.9及以上版本!!!__)
* 新增修改“webui请求api地址”的页面以及功能
* 接口数据类型对齐zhenxun_bot_v0.1.5.9
* 样式体验优化,移动端下样式优化

### 2022/5/31

* 样式表现优化
* 主界面移动端简易简易适配


### 2022/5/28

* 修复配置项和编辑项某些情况下修改出错的问题
* 改变用户身份信息储存方式,7天内可以免登陆
* 部分样式表现优化
* 控制台警告处理
</div>
Binary file added docs_image/0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs_image/tt.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e6ba8c4

Please sign in to comment.