Skip to content

Commit

Permalink
docs: install.md (#602)
Browse files Browse the repository at this point in the history
  • Loading branch information
fadeev authored Dec 23, 2020
1 parent f23476f commit a9eabb5
Showing 1 changed file with 11 additions and 23 deletions.
34 changes: 11 additions & 23 deletions docs/1 Introduction/2 Install.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,32 @@
# Install Starport

**Prerequisites:** If you want to install Starport locally, make sure to have [Golang >=1.14](https://golang.org/) and [Node.js >=12.19.0](https://nodejs.org/) installed on your system. The latest version of Starport also requires [Protocol Buffer compiler](https://grpc.io/docs/protoc-installation/) to be installed.
**Prerequisites:** If you want to install Starport locally, make sure to have [Golang >=1.14](https://golang.org/). The latest version of Starport also requires [Protocol Buffer compiler](https://grpc.io/docs/protoc-installation/) to be installed. [Node.js >=12.19.0](https://nodejs.org/) is used to build the welcome screen, block explorer and to run the web scaffold.

## Installation Options
To install Starport:

### NPM

```bash
npm i -g @tendermint/starport
```
curl https://i.jpillora.com/tendermint/starport! | bash
```

This command will download the latest `starport` binary from Github and install it into `/usr/local/bin`. To learn more about how to install previous versions of the binary, refer to the [documentation](https://github.com/jpillora/installer).

### macOS with Homebrew
## macOS with Homebrew

```
brew install tendermint/tap/starport
```

<!-- ### Debian/Ubuntu with Snapcraft
## Build from source

```bash
snap install --classic node
```
Append your current working directory to the environment variable `PATH`:
```
export PATH=$PATH:$PWD/node_modules/.bin/
``` -->

### Build from source on Mac, Linux, and WSL

```bash
git clone https://github.com/tendermint/starport && cd starport && make
```

You'll find a freshly-baked `starport` binary in the build folder.
This will build and install `starport` binary into `$GOBIN`.

Note: When building from source, it is important to have your GOPATH set correctly. When in doubt, the folllowing should do:
Note: When building from source, it is important to have your `$GOPATH` set correctly. When in doubt, the folllowing should do:

```bash
```
mkdir ~/go
export GOPATH=~/go
```

0 comments on commit a9eabb5

Please sign in to comment.