@gonsin/gview 1.0.1 → 1.0.2

package/README.md

@@ -1,26 +1,79 @@
-# gview
+<!--
+ * @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
 
-## Project setup
-```
+## 安装依赖
+
+```sh
 npm install
 ```
 
-### Compiles and hot-reloads for development
-```
+## 项目测试
+
+```sh
 npm run serve
 ```
 
-### Compiles and minifies for production
-```
+
+## 项目打包
+
+```sh
 npm run build
 ```
 
-### Run your tests
-```
-npm run test
-```
+## 项目发布
 
-### Lints and fixes files
+```sh
+npm publish
 ```
-npm run lint
+
+## 使用方法：
+
+详细参考 `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, //  新增该配置项
+  },
+},
+
+```