forked from rooch-network/rooch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
111 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
docs/website/pages/docs/developer-guides/typescript-sdk.en-US.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Start a New Rooch Project | ||
|
||
If you want to build a new app or a new website with Rooch, we recommend use rooch-create CLI create project. The CLI provides features that most apps and sites eventually need, including frameworks such as React and Vue (Vue support coming soon). It also encapsulates the relevant framework functionalities. | ||
|
||
## Note | ||
|
||
Before you begin, make sure to have Node.js installed for local development. | ||
|
||
## Create Project | ||
|
||
```shell | ||
npm create @roochnetwork/rooch <name> | ||
cd <name> | ||
npm dev | ||
``` | ||
|
||
This command sets up a new project named <name>, and you can navigate to it with cd <name>. Then, start the development server with npm dev. | ||
|
||
The project comes with a counter example. The Increase method in the counter contract can be invoked either through Rooch SDK calls or by initiating Ethereum transactions through Metamask. | ||
|
||
The Rooch context and wallet context are also included, making it easy to connect to wallets, send transactions, manage accounts, and handle chains. | ||
|
||
|
||
## Learn More | ||
|
||
Explore the Rooch SDK documentation (here)[https://www.npmjs.com/package/@roochnetwork/rooch-sdk]. |
25 changes: 25 additions & 0 deletions
25
docs/website/pages/docs/developer-guides/typescript-sdk.zh-CN.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# 创建一个新的 Rooch 项目 | ||
|
||
如果你想要使用 Rooch 构建一个新的应用程序或网站,我们建议使用 rooch-create CLI。CLI 提供了大多数应用程序和网站最终需要的功能,包括 React 和 Vue(即将推出)等框架的封装。 | ||
|
||
## 注意 | ||
|
||
在进行本地开发之前,请确保已安装 Node.js。 | ||
|
||
## 创建项目 | ||
|
||
```shell | ||
npm create @roochnetwork/rooch <name> | ||
cd <name> | ||
npm dev | ||
``` | ||
|
||
该命令会创建一个名为 <name> 的新项目,并可以通过 cd <name> 进入该项目。然后,使用 npm dev 启动开发服务器。 | ||
|
||
该项目包含一个计数器示例。计数器合约的 Increase 方法可以通过 rooch SDK 调用或通过 Metamask 发起以太坊交易来调用。 | ||
|
||
还包括了 Rooch 上下文和钱包上下文,方便连接钱包、发送交易、管理账户和处理链。 | ||
|
||
## 了解更多 | ||
|
||
查阅 (Rooch SDK 文档) [https://www.npmjs.com/package/@roochnetwork/rooch-sdk]。 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,23 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.js | ||
.yarn/install-state.gz | ||
|
||
# testing | ||
/coverage | ||
|
||
# next.js | ||
/.next/ | ||
/out/ | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.env | ||
.DS_Store | ||
*.pem | ||
|
||
# debug | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# local env files | ||
.env*.local | ||
|
||
# vercel | ||
.vercel | ||
|
||
# typescript | ||
*.tsbuildinfo | ||
next-env.d.ts | ||
*/**/.DS_Store | ||
npm-debug.log | ||
.npm/ | ||
/coverage | ||
/tmp | ||
node_modules | ||
.idea/ | ||
.history/ | ||
.vscode/ | ||
dist/ | ||
.nyc_output/ | ||
build/ | ||
|
||
# Doc generation output | ||
docs/ | ||
|
||
# client generation output | ||
generated/ | ||
|
||
# yarn error | ||
yarn-error.log |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "@roochnetwork/create-rooch", | ||
"version": "0.0.5", | ||
"version": "0.0.6", | ||
"description": "Create a new Rooch project", | ||
"license": "Apache-2.0", | ||
"author": "Rooch.network <[email protected]>", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
{ | ||
"name": "@roochnetwork/rooch-sdk", | ||
"author": "Rooch.network <[email protected]>", | ||
"version": "0.0.1", | ||
"version": "0.0.6", | ||
"description": "Rooch SDK", | ||
"license": "Apache-2.0", | ||
"engines": { | ||
|