Skip to content

Commit

Permalink
Add instructions for installing linter
Browse files Browse the repository at this point in the history
  • Loading branch information
thomshutt authored and emranemran committed Sep 7, 2022
1 parent 959cfb2 commit e7139c3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ GO_BUILD_DIR?=build/
ldflags := -X 'github.com/livepeer/catalyst-api/config.Version=$(shell git rev-parse HEAD)'

.PHONY: all
all: build fmt test
all: build fmt test lint

.PHONY: build
build:
Expand All @@ -13,6 +13,10 @@ build:
fmt:
go fmt ./...

.PHONY: lint
lint:
golangci-lint run

.PHONY: run
run:
go run cmd/http-server.go
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

An HTTP API to allow services (e.g Livepeer Studio) to interact with Catalyst.

## Prerequisites

The default Makefile goal and the CI process for this repo uses `golangci-lint` for linting. To install, follow the instructions at https://golangci-lint.run/usage/install/#local-installation

## Development

To test the [Catalyst](http://github.com/livepeer/catalyst) integration, follow the instructions in that repo to run a local Catalyst instance and then:
Expand All @@ -18,4 +22,4 @@ By default, this runs on a different port (`4949`) to the Catalyst one (`7979`)
curl 'http://localhost:4949/ok'
```

If you see a response body of `OK` then things are working and you can begin using this instance to test the API's integration with Mist and the other parts of the Catalyst system.
If you see a response body of `OK` then things are working and you can begin using this instance to test the API's integration with Mist and the other parts of the Catalyst system.

0 comments on commit e7139c3

Please sign in to comment.