update readme.md

This commit is contained in:
CaiHQ 2022-12-07 23:58:20 +08:00
parent 1b60a1b64a
commit dae0ee3726

View File

@ -1,10 +1,10 @@
# contract-java-example
#### 介绍
## 介绍
idea开发合约的示例。
#### 测试环境配置
## 测试环境配置
1. 在本地准备docker测试环境。
```bash
@ -15,12 +15,12 @@ cat bdcontract/manager.keypair
```
2. 打开浏览器`http://127.0.0.1:21030/NodePortal.html`。点击右上角`欢迎04xx`按钮将步骤1中的keyPair复制并点`导入密钥`。
### 开发环境配置
## 开发环境配置
可安装idea插件`ideaplugin/yjs-formater-1.0-SNAPSHOT-1653060411648.zip`
用于格式化yjs文件和自动补全。
#### 调试运行
## 在本机调试运行
1.修改debugconf.json,将cpHost改为从docker可访问的域名或ip。
@ -80,13 +80,20 @@ task copyToBDWareProjectDir(type: Copy) {
}
```
## 在docker内调试运行
#### 部署运行
打开镜像的`NodePortal.html`页面以ypk的形式启动。
在启动时,增加`remoteDebugPort`,注意远程调试的端口需要在镜像中映射出来。
可使用docker镜像默认映射端口范围`21050-21100`,例如`21058`。
而后即可通过jdwp可进行远程调试。 如果使用`idea`作为开发环境,则可搜索`idea java remote debug`,查看相关教程。
NodePortal.html可参考[BDContract管理页面](https://public.internetapi.cn/docs/bdcontract/doc/IDEUsage.html)
## 部署运行
部署至远程服务端执行":backend:deploy"任务:
即执行./backend/build.gradle 中的 deploy。
#### 前端sdk说明
## 前端sdk说明
1. 如何使用javascript sdk
2. 如何使用typescript sdk
@ -94,16 +101,16 @@ task copyToBDWareProjectDir(type: Copy) {
3. 如何配置成前后端独立连接的
4. 如何配置成前后端一体化
##### 模拟后端数据
## 模拟后端数据
#### 后端常用方法说明
## 后端常用方法说明
##### 调用相同CP的yjs代码
## 调用相同CP的yjs代码
参考:
Hello.callYJSInSameCP
##### 调用其他CP的yjs代码
## 调用其他CP的yjs代码
参考:
Hello.callYJSInOtherCP