@gonsin/gview 1.0.2 → 1.1.1

package/README.md

@@ -1,79 +1,87 @@
-<!--
- * @Author: lrm lrm@gonsin.cn
- * @Date: 2022-10-25 15:17:48
- * @LastEditors: lrm lrm@gonsin.cn
- * @LastEditTime: 2022-12-05 09:21:02
- * @FilePath: \client\README.md
- * @Description: 
- * 
- * Copyright (c) 2022 by lrm lrm@gonsin.cn, All Rights Reserved. 
--->
-# GView
-
-## 安装依赖
-
-```sh
-npm install
-```
-
-## 项目测试
-
-```sh
-npm run serve
-```
-
-
-## 项目打包
-
-```sh
-npm run build
-```
-
-## 项目发布
-
-```sh
-npm publish
-```
-
-## 使用方法：
-
-详细参考 `example` 项目。
-
-`main.js` 配置：
-
-```js
-// 引入 GView 标签
-import GView from "@gonsin/gview";
-Vue.use(GView);
-
-new Vue({
-  router,
-  store: GView.store, // 引入 GView 的 store
-  render: (h) => h(App),
-}).$mount("#app");
-
-```
-
-根据开发修改接口的地址：
-
-```js
-proxy: {
-  "/api": {
-    target: "http://192.168.2.192:8088",
-    changeOrigin: true,
-    disableHostCheck: false, //  新增该配置项
-  },
-  "/restapi": {
-    target: "http://192.168.2.192:8088",
-    changeOrigin: true,
-    disableHostCheck: false, //  新增该配置项
-  },
-  // 配置websocket开发时代理
-  "/gview/websocket": {
-    target: "ws://192.168.2.192:8088",
-    changeOrigin: true,
-    disableHostCheck: false, //  新增该配置项
-  },
-},
-
-```
+# GView
+
+<a href="https://www.npmjs.com/package/@gonsin/gview">
+    <img src="https://img.shields.io/npm/v/@gonsin/gview.svg?sanitize=true" alt="Version">
+</a>
+
+GView 项目的前端部分，接收处理来自服务器的 JSON 格式数据快速生成对应的表单、表格等视图。
+
+## 安装依赖
+
+```sh
+npm install
+```
+
+## 项目开发
+
+```sh
+npm run serve
+```
+
+## 项目打包
+
+```sh
+npm run build
+```
+
+## 项目发布
+
+```sh
+npm publish
+```
+
+## 实例项目运行
+
+```sh
+cd example
+npm install
+npm run serve
+```
+
+## 使用方法：
+
+详细参考 `example` 项目。
+
+`main.js` 配置：
+
+```js
+// 引入 GView 标签
+import GView from "@gonsin/gview";
+Vue.use(GView, { store });
+
+new Vue({
+    router,
+    render: (h) => h(App),
+}).$mount("#app");
+```
+
+根据开发修改接口的地址：
+
+```js
+proxy: {
+  "/api": {
+    target: "http://192.168.2.192:8088",
+    changeOrigin: true,
+    disableHostCheck: false, //  新增该配置项
+  },
+  "/restapi": {
+    target: "http://192.168.2.192:8088",
+    changeOrigin: true,
+    disableHostCheck: false, //  新增该配置项
+  },
+  // 配置websocket开发时代理
+  "/gview/websocket": {
+    target: "ws://192.168.2.192:8088",
+    changeOrigin: true,
+    disableHostCheck: false, //  新增该配置项
+  },
+},
+
+```
+
+另外 GView 提供了已经封装好的 axios 工具，可以直接引入使用：
+
+```js
+// 引入提供的axios封装工具
+import { http } from "@gonsin/gview";
+```