cerc-io/ipld-eth-server
18
0
Fork 1
Code Issues 10 Pull Requests 1 Actions Packages Projects Releases 37 Wiki Activity

Update docs to reflect using go mod

Browse Source
This commit is contained in:
Rob Mulholand 2019-07-17 15:29:24 -05:00
parent ca4451d914
commit 62e454b7fe
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -35,7 +35,7 @@ data from VulcanizeDB's underlying Postgres database and making it accessible.
1. [Configuring a synced Ethereum node](#configuring-a-synced-ethereum-node) 1. [Configuring a synced Ethereum node](#configuring-a-synced-ethereum-node)
### Dependencies ### Dependencies
- Go 1.11+ - Go 1.12+
- Postgres 11.2 - Postgres 11.2
- Ethereum Node - Ethereum Node
- [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8.23+) - [Go Ethereum](https://ethereum.github.io/go-ethereum/downloads/) (1.8.23+)
@ -46,16 +46,17 @@ Download the codebase to your local `GOPATH` via:
`go get github.com/vulcanize/vulcanizedb` `go get github.com/vulcanize/vulcanizedb`
Move to the project directory and use [golang/dep](https://github.com/golang/dep) to install the dependencies: Move to the project directory:
`cd $GOPATH/src/github.com/vulcanize/vulcanizedb` `cd $GOPATH/src/github.com/vulcanize/vulcanizedb`
`dep ensure` Be sure you have enabled Go Modules (`export GO111MODULE=on`), and build the executable with:
Once the dependencies have been successfully installed, build the executable with:
`make build` `make build`
If you need to use a different dependency than what is currently defined in `go.mod`, it may helpful to look into [the replace directive](https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive).
This instruction enables you to point at a fork or the local filesystem for dependency resolution.
If you are running into issues at this stage, ensure that `GOPATH` is defined in your shell. If you are running into issues at this stage, ensure that `GOPATH` is defined in your shell.
If necessary, `GOPATH` can be set in `~/.bashrc` or `~/.bash_profile`, depending upon your system. If necessary, `GOPATH` can be set in `~/.bashrc` or `~/.bash_profile`, depending upon your system.
It can be additionally helpful to add `$GOPATH/bin` to your shell's `$PATH`. It can be additionally helpful to add `$GOPATH/bin` to your shell's `$PATH`.

2
documentation/custom-transformers.md
View File

@ -39,7 +39,7 @@ or [contract](../../staging/libraries/shared/watcher/contract_watcher.go#L68) wa
* If the base vDB migrations occupy this path as well, they need to be in their `goose fix`ed form * If the base vDB migrations occupy this path as well, they need to be in their `goose fix`ed form
as they are [here](../../staging/db/migrations) as they are [here](../../staging/db/migrations)
To update a plugin repository with changes to the core vulcanizedb repository, run `dep ensure` to update its dependencies. To update a plugin repository with changes to the core vulcanizedb repository, use your dependency manager to install the desired version of vDB.
## Building and Running Custom Transformers ## Building and Running Custom Transformers
### Commands ### Commands