README.md · 解老师/balloonfish

# balloonfish(河豚)

<div align="center">
<img src="https://www.hualigs.cn/image/60eff6950916d.jpg"/>
</div>
<br/>
<div align="center">
🚀一款基于electron+vue3+vite2.0的TDengine时序库可视化管理工具🚀
</div>
<br/>

从2019年年底接触[TDengine](https://github.com/taosdata/TDengine)，就产生了为其开发一款可视化管理工具的想法，可惜要么工作忙要么发懒，一直没有着手去做，直到今年3月份看到了一个名为[TDengineGUI](https://github.com/skye0207/TDengineGUI)的项目，深受启发，并打算使用vue3重构一版，然后就又碰上了公司里大项目、建党100周年活动等等..... 总之又鸽了几个月。现在终于写出个模样来了。

## 感谢

首先感谢[@skye0207](https://github.com/skye0207)的[TDengineGUI](https://github.com/skye0207/TDengineGUI)项目！本项目的灵感来源！并且采用了其封装的工具类和数据分页展示的代码

然后要感谢[@qishibo](https://github.com/qishibo)的[AnotherRedisDesktopManager](https://github.com/qishibo/AnotherRedisDesktopManager)项目，为本项目提供了UI的思路

最后要感谢[@caoxiemeihao](https://github.com/caoxiemeihao)的[electron-vue-vite](https://github.com/caoxiemeihao/electron-vue-vite)项目，可以方便的把vite打包到electron中

## how to run and build

### 安装依赖

```
npm install
```

### 运行WEB版

```
npm run web
```

### 运行桌面版

```
npm start
```

### 编译打包Web版本

```
npm run build:web
```

### 编译打包桌面版

```
npm run build
```

网页版编译后位于 `dist` 文件夹，需要挂服务才能运行，桌面版编译后位于 `release` 文件夹

注意：编译桌面版时，第一次需要FQ下载依赖！

## 当前版本功能

* 采用多标签页形式
* 通过restful接口连接到数据库，基本不受服务端版本升级影响
* 数据库添加、删除操作
* 创建、删除超级表
* 创建、删除表（支持以超级表为模板和直接创建两种模式）
* 用户管理（需要以root账户登录）
* 超级表和表的分页查询，把表的TAG和超级表的TAG列标识出来，可以按时间段检索、字段过滤、排序
* 自定义SQL查询（由于用了vxetable虚拟表格，几万条数据也不卡顿！）
* 超级表和表分别整理成树（超级表-表的树形结构不打算做了，因为有的表不是以超级表为模板创建的）
* 充分利用vue组件化的特点，把不同模块封装成不同组件，易于维护
* 数据量大的情况下，会自动询问是否切换为时间正序

## TODO List

* 数据库编辑（如果官方支持）
* 超级表和表的字段编辑
* 数据库、表、超级表的信息展示
* 服务端状态检测，例如CPU、内存、硬盘占用等等（依据log库）
* 图表展示数据趋势，并显示数据统计量（求和，平均，方差等）
* 修改连接配置信息功能
* 连接配置信息导出导入功能
* 基础属性配置功能（连接超时时间、默认每页大小等）
* 根据数据库版本更新，增减功能

解老师/balloonfish

简介

发行版 (2)

贡献者

近期动态

解老师/balloonfish .gitee-modal { width: 500px !important; }

简介

发行版 (2)

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

解老师/balloonfish