go-view/README.md

137 lines
3.5 KiB
Markdown
Raw Normal View History

2022-05-04 13:50:40 +08:00
## 总览
2022-06-17 14:11:13 +08:00
2022-05-06 20:23:08 +08:00
![logo](readme/logo-t-y.png)
2022-05-04 20:45:25 +08:00
2022-06-10 16:27:34 +08:00
GoView 是一个高效的拖拽式低代码数据可视化开发平台,将图表或页面元素封装为基础组件,无需编写代码即可制作数据大屏,减少心智负担。
2022-06-17 14:11:13 +08:00
### 纯 **😶 前端** 分支: **`master`**
2022-06-10 16:27:34 +08:00
2022-06-17 14:11:13 +08:00
### 携带 **👻 后端** 请求分支: **`master-fetch`**
2022-05-04 13:50:40 +08:00
2022-06-26 15:11:52 +08:00
### GoView **📚 文档** 地址:[http://www.mtruning.club:81/](http://www.mtruning.club:81/)
2022-05-31 11:36:26 +08:00
项目纯前端-Demo 地址:[https://www.mtruning.club](https://www.mtruning.club)
2022-06-03 19:56:03 +08:00
项目带后端-Demo 地址:[后端 Demo 地址](http://1.117.240.165:8080/goview/#/login)
2022-05-04 13:50:40 +08:00
2022-05-04 14:35:50 +08:00
文档-在线地址:[http://www.mtruning.club:81/](http://www.mtruning.club:81/)
文档-源码地址:[https://gitee.com/MTrun/go-view-doc](https://gitee.com/MTrun/go-view-doc)
2022-05-04 13:50:40 +08:00
技术点:
- 框架:基于 `Vue3` 框架编写,使用 `hooks` 写法抽离部分逻辑,使代码结构更加清晰;
- 类型:使用 `TypeScript` 进行类型约束,减少未知错误发生概率,可以大胆修改逻辑内容;
- 性能:多处性能优化,使用页面懒加载、组件动态注册、数据滚动加载等方式,提升页面渲染速度;
- 存储:拥有本地记忆,部分配置项采用 `storage` 存储本地,提升使用体验;
- 封装:项目进行了详细的工具类封装如:路由、存储、加/解密、文件处理、主题、NaiveUI 全局方法、组件等
2022-05-04 20:45:25 +08:00
项目截图:
2022-05-06 20:23:08 +08:00
![项目截图](readme/goView-canvas.png)
2022-05-04 20:45:25 +08:00
主要技术栈为:
2022-05-04 13:50:40 +08:00
| 名称 | 版本 | 名称 | 版本 |
| ------------------- | ----- | ----------- | ------ |
| Vue | 3.2.x | TypeScript4 | 4.6.x |
| Vite | 2.9.x | NaiveUI | 2.27.x |
| ECharts | 5.3.x | Pinia | 2.0.x |
2022-06-17 14:11:13 +08:00
| 详见 `package.json` | 😁 | 🥰 | 🤗 |
2022-05-04 13:50:40 +08:00
开发环境:
| 名称 | 版本 | 名称 | 版本 |
| ---- | ------- | ------- | ----- |
| node | 16.14.x | npm | 8.5.x |
2022-06-17 14:11:13 +08:00
| pnpm | 7.1.x | windows | 11 |
2022-05-04 13:50:40 +08:00
已完成图表:
2022-06-17 14:11:13 +08:00
| 分类 | 名称 | 名称 | 名称 |
| ------ | ---------------- | ---------------- | -------- |
| 图表 | 柱状图 | 横向柱状图 | 折线图 |
| \* | 单/多 折线面积图 | 饼图 | 水球图 |
| \* | 环形图 | NaiveUI 多种进度 | 🤠 |
| 信息 | 文字 | 图片 | 😶 |
| 列表 | 滚动排名列表 | 滚动表格 | 🤓 |
| 小组件 | 边框-01~13 | 装饰-01~05 | 数字翻牌 |
2022-05-04 13:50:40 +08:00
## 浏览器支持
2022-05-12 11:20:36 +08:00
开发和测试平台均在 `Google` 和最新版 `EDGE` 上完成,暂未测试 `IE11` 等其它浏览器,如有需求请自行测试与兼容。
2022-05-04 13:50:40 +08:00
## 安装
2022-06-15 16:15:49 +08:00
本项目采用` pnpm` 进行包管理
2022-05-04 13:50:40 +08:00
```shell
2022-06-15 16:15:49 +08:00
#建议使用 nrm 切换到淘宝源 https://registry.npmmirror.com/
#pnpm
2022-05-04 13:50:40 +08:00
pnpm install
2022-06-15 16:15:49 +08:00
#yarn
yarn install
#npm
npm install
2022-05-04 13:50:40 +08:00
```
## 启动
```shell
#pnpm
pnpm dev
# npm
npm run dev
#yarn
yarn dev
#Makefile
make dev
```
## 编译
```shell
#pnpm
pnpm run build
# npm
npm run build
#yarn
yarn run build
#Makefile
make dist
```
2022-06-17 14:11:13 +08:00
## 代码提交
2022-06-17 14:11:13 +08:00
- feat: 新功能
- fix: 修复 Bug
- docs: 文档修改
- perf: 性能优化
- revert: 版本回退
- ci: CICD 集成相关
- test: 添加测试代码
- refactor: 代码重构
- build: 影响项目构建或依赖修改
- style: 不影响程序逻辑的代码修改
- chore: 不属于以上类型的其他类型(日常事务)
2022-05-04 13:50:40 +08:00
## 交流
2022-05-04 13:53:23 +08:00
QQ 群1030129384
2022-05-06 20:23:08 +08:00
![QQ群](readme/goView-QQ.png)
2022-05-04 20:45:25 +08:00
2022-05-06 20:23:08 +08:00
![渲染海报](readme/logo-poster.png)