@abtnode/schema 1.15.17 → 1.16.0-beta-b16cb035

package/README.md

@@ -4,38 +4,82 @@ Defines data structure for ABT Node backend API, and maintains schema for GQL en
 
 ## Development
 
-### Install gun-sed
+You can choose one of the following two ways to build schema.
+It is recommended to build with Docker.
 
-- Mac: brew install gnu-sed
-- Other platform: https://www.gnu.org/software/sed/
+### Option 1. Build schema with Docker
 
-### Install protobuf
+Requirements:
+
+- Docker
+
+```bash
+docker pull arcblock/blocklet-server-proto
+docker run --rm -v {absolute path of core/schema}:/home/root/schema arcblock/blocklet-server-proto
+```
+
+### Option 2. Build schema with Go
+
+Requirements:
+
+- go 1.8+
+
+#### Install go
+
+- Mac: brew install go
+- Other platform: https://go.dev/doc/install
+
+```shell
+# you can use `go env` to check the go environment
+go env
+
+```
+
+#### Install gnu-sed(MacOS)
+
+```bash
+# Install(Mac OS), other platform: https://www.gnu.org/software/sed/
+brew install gnu-sed
+# Make `sed` command work, only for homebrew:
+PATH="$(brew --prefix)/opt/gnu-sed/libexec/gnubin:$PATH"
+```
+
+#### Install protobuf
 
 - Mac: brew install protobuf
 - Other platform: https://developers.google.com/protocol-buffers/docs/downloads
 
-### Add to `~/.profile`
+#### Add to `~/.profile`
+
+```shell
+
+vim ~/.profile
+
+# add the profile to the end of the file
+# ----------------------------------------------------------
 
-```
 export GO111MODULE=on
 export GOPROXY=https://goproxy.cn
 
-export GOROOT=/usr/local/Cellar/go/1.15.5/libexec // you local go path
+# you can query the GOROOT/GOPATH/GOBIN by `go env`
+export GOROOT=/usr/local/Cellar/go/1.15.5/libexec // replace to your local go path
 export GOPATH=$HOME/.golang
 export GOBIN=$GOPATH/bin
 export PATH=$PATH:$GOROOT:$GOPATH:$GOBIN
-PATH="/usr/local/opt/gnu-sed/libexec/gnubin:$PATH"
-```
+
+# ----------------------------------------------------------
 
 source ~/.profile
 
-### Install other dependencies
+```
+
+#### Install other dependencies
 
 Run `make init`
 
 > If there is a network problem, try to change golang registry by https://goproxy.cn/
 
-### Build Schema
+#### Build Schema
 
 Run `make build`
 
@@ -45,21 +89,23 @@ Run `make build`
 
 After update the schema proto, run `make build` get the latest schema.
 
-### 2. go to core/gql start a demo endpoint
+> If you are using mac, you may need replace the `sed` command with `gsed`
+
+### 2. go to core/webapp start a demo endpoint
 
 just run：
 
-```
-node demo.js
+```shell
+node tools/start-upgrade-server.js
 ```
 
-> should make sure the DB Proxy is running
+> should make sure the DB Proxy is running, if not, run `yarn start` in a new terminal
 
 ### 3. go to core/client do finally update
 
 just run:
 
-```
+```shell
 npm run upgrade
 ```