-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Add PATH gateway cheat sheet (#964)
## Summary Add `PATH Gateway` cheat sheet to documentation ## Issue Add easy to follow instructions to setup and run a `PATH Gateway` - #901 ## Type of change Select one or more from the following: - [ ] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [x] Documentation - [ ] Other (specify) ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes ## Sanity Checklist - [x] I have tested my changes using the available tooling - [ ] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [x] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Daniel Olshansky <[email protected]>
- Loading branch information
Showing
4 changed files
with
300 additions
and
8 deletions.
There are no files selected for viewing
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
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 |
---|---|---|
|
@@ -17,6 +17,8 @@ brew install poktrolld | |
- [MacOS \& Linux Users](#macos--linux-users) | ||
- [Using Homebrew](#using-homebrew) | ||
- [From Source](#from-source) | ||
- [Installing dependencies](#installing-dependencies) | ||
- [Installing poktrolld](#installing-poktrolld) | ||
- [Using release binaries](#using-release-binaries) | ||
- [Windows Users](#windows-users) | ||
|
||
|
@@ -48,12 +50,32 @@ or debug the CLI. | |
|
||
### From Source | ||
|
||
#### Installing dependencies | ||
|
||
Ensure you have the following installed: | ||
|
||
- [Go](https://go.dev/doc/install) (version 1.18 or later) | ||
- [Ignite CLI](https://docs.ignite.com/welcome/install) | ||
|
||
Then run the following commands: | ||
If you're on a Linux machine, you can follow the steps below for convenience: | ||
|
||
```bash | ||
# Install go 1.23 | ||
curl -o ./pkgx --compressed -f --proto '=https' https://pkgx.sh/$(uname)/$(uname -m) | ||
sudo install -m 755 pkgx /usr/local/bin | ||
pkgx install [email protected] | ||
export PATH=$PATH:$HOME/go/bin/ | ||
|
||
# Install PATH Gateway required dependencies | ||
apt-get update && apt-get install git make build-essential | ||
|
||
# Install the ignite binary used to build the Pocket binary | ||
curl https://get.ignite.com/cli! | bash | ||
``` | ||
|
||
#### Installing poktrolld | ||
|
||
Then, Retrieve the source code and build the `poktrolld` locally like so: | ||
|
||
```bash | ||
git clone https://github.com/pokt-network/poktroll.git | ||
|