diff --git a/README.md b/README.md index 725de5d6..8d5fb9fe 100644 --- a/README.md +++ b/README.md @@ -1 +1,104 @@ -# Vue3 + Typescript + Vite2 + NaiveUI + ECharts + Axios + Pinia2 + Plop \ No newline at end of file +# 开始 + +## 总览 + +GoView 是一个高效的拖拽式低代码数据可视化开发平台,将图表或页面元素封装为基础组件,无需编写代码即可制作数据大屏,减少心智负担。当然低代码也不是 “银弹”,希望所有人员都能理智看待此技术。 + +在线 Demo 地址:[https://www.mtruning.club](https://www.mtruning.club) + +Gitee 源码地址:[https://gitee.com/MTrun/go-view](https://gitee.com/MTrun/go-view) + +技术点: + +- 框架:基于 `Vue3` 框架编写,使用 `hooks` 写法抽离部分逻辑,使代码结构更加清晰; + +- 类型:使用 `TypeScript` 进行类型约束,减少未知错误发生概率,可以大胆修改逻辑内容; + +- 性能:多处性能优化,使用页面懒加载、组件动态注册、数据滚动加载等方式,提升页面渲染速度; + +- 存储:拥有本地记忆,部分配置项采用 `storage` 存储本地,提升使用体验; + +- 封装:项目进行了详细的工具类封装如:路由、存储、加/解密、文件处理、主题、NaiveUI 全局方法、组件等 + +部分技术栈为: + +| 名称 | 版本 | 名称 | 版本 | +| ------------------- | ----- | ----------- | ------ | +| Vue | 3.2.x | TypeScript4 | 4.6.x | +| Vite | 2.9.x | NaiveUI | 2.27.x | +| ECharts | 5.3.x | Pinia | 2.0.x | +| 详见 `package.json` | 😁 | 🥰 | 🤗 | + +开发环境: + +| 名称 | 版本 | 名称 | 版本 | +| ---- | ------- | ------- | ----- | +| node | 16.14.x | npm | 8.5.x | +| pnpm | 6.32.x | windows | 11 | + +已完成图表: + +| 分类 | 名称 | 名称 | 名称 | +| ------ | ---------------- | ---------- | -------- | +| 图表 | 柱状图 | 横向柱状图 | 折线图 | +| \* | 单/多 折线面积图 | 饼图 | 水球图 | +| 信息 | 文字 | 图片 | 😶 | +| 列表 | 滚动排名列表 | 🤠 | 🤓 | +| 小组件 | 边框-01~13 | 装饰-01~05 | 数字翻牌 | + +## 浏览器支持 + +开发和测试平台均在 Google 和最新版 EDGE 上完成,暂未测试 IE11 等其它浏览器,如有需求请自行测试与兼容。 + +## 安装 + +本项目采用 pnpm 进行包管理,若要使用其它管理方式,请删除 `pnpm-lock.yaml` 并安装依赖 + +```shell +#pnpm(建议使用nrm切换到淘宝源) +pnpm install + +# npm +npm install + +# yarn +yarn install + +``` + +## 启动 + +```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 + +``` + +## 交流 + +QQ 群:1030129384 \ No newline at end of file