Improve Makefile (#223)

Author: Blinkuu

Makefile

@@ -1,36 +1,51 @@
 GO_SOURCES=$(shell find . -type f -name '*.go' -not -path "./vendor/*")
 FRONTEND_BUILD_DIR = pkg/web/build
 
-# Builds frontend and backend Go code.
-build:
+.PHONY: build
+build: build-web build-go # Builds frontend and backend
+
+.PHONY: build-web
+build-web: # Build frontend assets
 	rm -rf $(FRONTEND_BUILD_DIR)
 	export PUBLIC_BACKEND_ENDPOINT="" && \
 	export PUBLIC_BACKEND_WS_ENDPOINT="" && \
 	cd pkg/web && npm install && npm run build
-	make build-go
 
-# Does not (re)build frontend files, only Go code.
-build-go:
+.PHONY: build-go
+build-go: # Build Go binary (doesn't rebuild frontend)
 	mkdir -p $(FRONTEND_BUILD_DIR)
 	test -e $(FRONTEND_BUILD_DIR)/index.html || \
 		cp pkg/web/dev.html $(FRONTEND_BUILD_DIR)/index.html
 	go build -o bin/quickpizza ./cmd
 
 .PHONY: proto
-proto:
+proto: # Generate protobuf files
 	protoc --go_out=. --go-grpc_out=. proto/quickpizza.proto
 
-format:
+.PHONY: format
+format: format-go format-web
+
+.PHONY: format-go
+format-go: # Format Go code with goimports
 	@goimports -w -l $(GO_SOURCES)
 
-format-web:
+.PHONY: format-web
+format-web: # Format frontend code
 	cd pkg/web/ && npm run format
 
-format-check:
+.PHONY: format-check
+format-check: # Check Go code formatting
 	@out=$$(goimports -l $(GO_SOURCES)) && echo "$$out" && test -z "$$out"
 
-docker-build:
+.PHONY: docker-build
+docker-build: # Build Docker image
 	docker build . -t grafana/quickpizza-local:latest
 
-docker-run:
+.PHONY: docker-run
+docker-run: # Run Docker container
 	docker run --rm -it -p 3333:3333 -p 3334:3334 -p 3335:3335 -v $$(pwd):/db -e QUICKPIZZA_DB=file:/db/quickpizza.db grafana/quickpizza-local:latest
+
+.PHONY: help
+help: # Show help for each of the Makefile recipes.
+	@grep -E '^[a-zA-Z0-9 -]+:.*#'  Makefile | sort | while read -r l; do printf "\033[1;32m$$(echo $$l | cut -f 1 -d':')\033[00m:$$(echo $$l | cut -f 2- -d'#')\n"; done
+