update Makefile and README template (#95)

Author: hgiasac

Makefile

@@ -1,5 +1,6 @@
 VERSION ?= $(shell date +"%Y%m%d")
 OUTPUT_DIR := _output
+ROOT_DIR := $(shell pwd)
 
 .PHONY: typegen
 typegen:
@@ -9,10 +10,32 @@ typegen:
 format:
 	gofmt -w -s .
 
-.PHONY: test
-test:
+
+.PHONY: test-sdk
+test-sdk:
 	go test -v -race -timeout 3m ./...
 
+.PHONY: test-hasura-ndc-go
+test-hasura-ndc-go:
+	cd cmd/hasura-ndc-go && \
+		go test -v -race ./...
+
+.PHONY: test-example-codegen
+test-example-codegen:
+	cd example/codegen && \
+		go test -v -race ./...
+
+.PHONY: test
+test: test-sdk test-hasura-ndc-go test-example-codegen
+
+.PHONY: go-tidy
+go-tidy:
+	go mod tidy
+	cd $(ROOT_DIR)/cmd/hasura-ndc-go && go mod tidy
+	cd $(ROOT_DIR)/cmd/hasura-ndc-go/testdata/basic/source && go mod tidy
+	cd $(ROOT_DIR)/cmd/hasura-ndc-go/testdata/empty/source && go mod tidy
+	cd $(ROOT_DIR)/example/codegen && go mod tidy
+	
 # Install golangci-lint tool to run lint locally
 # https://golangci-lint.run/usage/install
 .PHONY: lint

cmd/hasura-ndc-go/templates/new/Makefile.tmpl

@@ -1,30 +1,34 @@
+.DEFAULT_GOAL := help
 ROOT = $(shell pwd)
 
 .PHONY: start
-start:
+start: ## Start the server with go run
 	cd .hasura-connector/scripts && \
   HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH=$(ROOT) $(SHELL) ./start.sh
 
 .PHONY: update
-update:
+update: ## Update schema and code generation
 	cd .hasura-connector/scripts && \
   HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH=$(ROOT) $(SHELL) ./update.sh
 
 .PHONY: watch
-watch:
+watch: ## Watch code changes and live reload
 	cd .hasura-connector/scripts && \
   HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH=$(ROOT) $(SHELL) ./watch.sh
 
 .PHONY: format
-format:
+format: ## Format go files
 	gofmt -w -s .
 
 .PHONY: test
-test:
-	go test -v -race -timeout 3m ./...
+test: ## Run unit tests
+	go test -v ./...
 
-# Install golangci-lint tool to run lint locally
-# https://golangci-lint.run/usage/install
 .PHONY: lint
-lint:
-	golangci-lint run
+lint: ## Install golangci-lint tool to run lint locally https://golangci-lint.run/usage/install
+	golangci-lint run
+
+help:
+	@echo ""
+	@echo "Usage:"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?##"}; {printf "  \033[36m%-30s\033[0m %s\n", $$1, $$2}'

cmd/hasura-ndc-go/templates/new/README.md.tmpl

@@ -4,40 +4,56 @@
 
 ### DDN CLI
 
-DDN CLI automatically starts the connector with `ddn dev` command that uses Docker Compose internally. 
-Docker Compose can watch changes in the source code and rebuild the connector. However, this connector limits the changes in the root folder only to avoid rebuild noises.
-After editing files in child folders, save any `*.go` file in the root folder to trigger the build.
+The boilerplate follows [Native Connector Packaging](https://github.com/hasura/ndc-hub/blob/main/rfcs/0004-native-packaging.md) with convenience shell scripts at [the connector definition folder](.hasura-connector/scripts). DDN CLI can automatically invoke those scripts when developing with DDN projects.
 
-### Native Go
+### Convenience scripts (Linux & MacOS)
 
-Start the connector server at http://localhost:8080
+You can run the convenience script with `make`. Those commands reuse native scripts at [the connector definition folder](.hasura-connector/scripts).
 
-```go
-go run . serve
+```sh
+Usage:
+  start   Start the server with go run
+  update  Update schema and code generation
+  watch   Watch code changes and live reload
 ```
 
-## Code generation
+### Manual installation
 
-### Convenience script (Linux & MacOS only)
+Install following tools for development:
 
-You can run the convenience script with `make` or with the bash file directly. 
-The script automatically downloads the tool and runs the `generate` command.
+- [hasura-ndc-go](https://github.com/hasura/ndc-sdk-go/tree/main/cmd/hasura-ndc-go)
+- [air](https://github.com/cosmtrek/air) (optional, install if you want live reload)
 
-```bash
-make generate
+```sh
+go install github.com/hasura/ndc-sdk-go/cmd/hasura-ndc-go@latest
+# downgrade lower version if you don't use the latest Go
+go install github.com/cosmtrek/air@latest
 ```
 
-```bash
-sh ./scripts/generate.sh
+#### Live reload
+
+**Linux & MacOS**
+
+```sh
+air -c air -c .air.toml
 ```
 
-### Manually download
+**Windows**
 
-Download the `hasura-ndc-go` tool at the [release page](https://github.com/hasura/ndc-sdk-go/releases/tag/{{.Version}}) page.
-Navigate to the root project folder and run `generate` whenever there are new changes from NDC functions and types.
+```sh
+air -c air -c .air.windows.toml
+```
+
+#### Manual
+
+Whenever modifying NDC types and functions in the `functions` folder, you need to generate NDC schema and codes.
 
 ```sh
 hasura-ndc-go generate
 ```
 
-See [NDC Go SDK](https://github.com/hasura/ndc-sdk-go/tree/v0) for more information and [the generation tool](https://github.com/hasura/ndc-sdk-go/tree/v0/cmd/hasura-ndc-go) for command documentation.
+Start the connector server at http://localhost:8080
+
+```go
+go run . serve
+```