README.cn.md

ocap-vue-starter

集成了 OCAP JS SDK 的种子项目，使用 @vue/cli 初始化。

For English documentation, please checkout README.md

使用方法

1. 作为 vue-cli 的 preset 使用

确保系统中已经安装 vue-cli，直接运行如下命令，初始化项目

vue create --preset ArcBlock/ocap-vue-starter my-ocap-dapp
cd my-ocap-dapp
yarn
yarn serve

2. 作为种子项目：直接克隆使用

git clone https://github.com/ArcBlock/ocap-vue-starter.git
cd ocap-vue-starter
yarn
yarn serve

如果是国内开发者，建议使用淘宝源安装依赖: yarn --registry=https://registry.npm.taobao.org

OCAP SDK 代码示例

• SDK 初始化和封装：src/libs/ocap.js
• 使用 SDK 做查询：src/views/Query.vue
• 使用 SDK 做实时数据订阅：src/views/Subscription.vue

OCAP SDK 文档

• SDK 源码和文档首页
• Bitcoin API 列表和响应格式
• Ethereum API 列表和响应格式

OCAP 提供的工具

• OCAP Playground：快速执行查询、预览结果
• OCAP Playbook：记录、分享基于区块链的数据研究

项目内含的三方库

• vue-router
• semantic-ui-vue
• semantic-ui-css

项目部署

如果看到这里，恭喜你，马上就可以把项目部署到公网，给大家试用了，我们建议使用 now.sh 部署应用，步骤如下：

1. 到 https://zeit.co 创建账号
2. 安装 zeit cli: npm install -g now
3. 登录 zeit-cli, now login
4. 在 deploy.sh 中设置项目的域名 alias
5. 执行 npm run deploy

部署成功！很期待你的应用出现在我们的 APP Gallery 里面。

重要提示

template 目录仅仅重复了根目录下的部分文件给 vue-cli 用，里面的文件不需要手动修改，如果需要更新，直接运行 npm run prepublish。