Skip to content

Commit

Permalink
fix: case sensitive typo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
2color committed Jul 26, 2024
1 parent 34a0185 commit 4300df4
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
ipfs-check
=======================
# ipfs-check

> Check if you can find your content on IPFS
A tool for checking the accessibility of your data by IPFS peers

## Documentation


### Build

`go build` will build the server binary in your local directory

### Install

`go install` will build and install the server binary in your global Go binary directory (e.g. `~/go/bin`)

### Deploy
Expand All @@ -23,6 +22,7 @@ Maybe just deploy it on IPFS and reference it with DNSLink.
For anything other than local testing you're going to want to have a proxy to give you HTTPS support on the Go server.

When deploying to prod, since the addition of telemetry (https://github.com/ipfs-shipyard/ipfs-check/pull/30) you will also need to run the following before serving the web assets:

```
cd web
npm install && npm run build
Expand All @@ -42,16 +42,18 @@ docker run -d ipfs-check
## Running locally

### Terminal 1

```
go build
./ipfs-check # Note listening port.. output should say something like "listening on [::]:3333"
```

### Terminal 2

```
# feel free to use any other tool to serve the contents of the /web folder (you can open the html file directly in your browser)
npx -y serve -l 3000 web
# Then open http://localhost:3000?backendUrl=http://localhost:3333
# Then open http://localhost:3000?backendURL=http://localhost:3333
```

## License
Expand Down

0 comments on commit 4300df4

Please sign in to comment.