docs: add quickstart to enable devs to spin up json rpc relay #4640
Conversation
Updated the README to include quickstart instructions and environment variable configuration. Signed-off-by: jaycoolslm <86686746+jaycoolslm@users.noreply.github.com>
Revise README for quickstart and configuration steps
Added instructions to copy the example environment file. Signed-off-by: jaycoolslm <86686746+jaycoolslm@users.noreply.github.com>
Signed-off-by: Jake Hall <jake.hall@hashgraph.com>
Signed-off-by: jaycoolslm <86686746+jaycoolslm@users.noreply.github.com>
jaycoolslm
requested review from
Ferparishuertas,
andrewb1269 and
arianejasuwienas
| @@ -78,7 +78,6 @@ | |||
| "version": "2.2.1", | |||
| "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.1.tgz", | |||
| "integrity": "sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg==", | |||
| "peer": true, | |||
There was a problem hiding this comment.
Could you revert the changes to this file so the PR can focus solely on the document addition?
| HEDERA_NETWORK= # Which network to connect to. Can be: previewnet, testnet, mainnet or a map of IPs and nodes e.g. {"127.0.0.1:50211":"0.0.3"} | ||
| MIRROR_NODE_URL= # The Mirror Node API endpoint e.g. https://testnet.mirrornode.hedera.com or https://mainnet.mirrornode.hedera.com | ||
| # Operator Account (Required for transaction execution; use the Hedera Portal (https://hubs.ly/Q03Vw-vN0) account for 1000 HBAR / day) |
There was a problem hiding this comment.
What is https://hubs.ly/Q03Vw-vN0? Can we not include it?
There was a problem hiding this comment.
Yes, it might be better to use a faucet address with our domain.
Also, I would avoid the bracket-inside-a-bracket construction. Maybe use markdown format [Hedera Portal](address to hedera portal) instead?
Also, I'm missing information that the description about the faucet applies only to the testnet/previewnet configuration.
| 3. Run `npm run start`. This will start the server on port `7546`. | ||
| ```bash | ||
| git clone https://github.com/hiero-ledger/hiero-json-rpc-relay.git | ||
| cd hiero-json-rpc-relay |
There was a problem hiding this comment.
We should still add steps to install packages and build the project as well, right?
There was a problem hiding this comment.
Not in the instructions for starting the dockerized version of the application, but we could include an alternative section on running it directly with npm start as well.
There was a problem hiding this comment.
Alternatively, we shouldn't keep Node/NPM in the requirements, because they no longer apply to the docker-only startup instruction.
4 participants
Description
This PR adds a quickstart to enable devs to spin up json rpc relay
Related issue(s)
Fixes #
Testing Guide
Changes from original design (optional)
N/A
Additional work needed (optional)
N/A
Checklist