add documentation to the makefile

This commit is contained in:
Ruidy 2024-11-14 22:33:45 +01:00
parent 5aa67ea1bf
commit 05a53d61b8
No known key found for this signature in database
GPG key ID: E00F51288CB857CC

View file

@ -3,24 +3,31 @@ PORT=8000
DB_USER=ruidy DB_USER=ruidy
DB_NAME=villafleurie DB_NAME=villafleurie
build: format lint build: format lint ## Build the binary
@docker build -t ${NAME}:latest . @docker build -t ${NAME}:latest .
run: build run: build ## Run the binary
@docker run -p ${PORT}:${PORT} -e DATABASE_URL="host=docker.for.mac.host.internal user=${DB_USER} database=${DB_NAME}" -e PORT=${PORT} ${NAME} @docker run -p ${PORT}:${PORT} -e DATABASE_URL="host=docker.for.mac.host.internal user=${DB_USER} database=${DB_NAME}" -e PORT=${PORT} ${NAME}
dev: dev: ## Run the binary in dev mode
@docker build -t ${NAME}:dev -f Dockerfile.dev . @docker build -t ${NAME}:dev -f Dockerfile.dev .
@docker run -p ${PORT}:${PORT} --rm -v `pwd`:/app -v /app/tmp --name ${NAME} -e DATABASE_URL="host=docker.for.mac.host.internal user=${DB_USER} database=${DB_NAME}" -e PORT=${PORT} ${NAME}:dev @docker run -p ${PORT}:${PORT} --rm -v `pwd`:/app -v /app/tmp --name ${NAME} -e DATABASE_URL="host=docker.for.mac.host.internal user=${DB_USER} database=${DB_NAME}" -e PORT=${PORT} ${NAME}:dev
test: test: ## Run the tests
@go test ./... @go test ./...
up-deps: up-deps: ## Update dependencies
@go get -u ./... @go get -u ./...
cron: cron: ## Run the cron
@go run cmd/cron/main.go @go run cmd/cron/main.go
format: format: ## Format the code
@templ generate internal/views @templ generate internal/views
@templ fmt . @templ fmt .
@go fmt ./... @go fmt ./...
lint: lint: ## Lint the code
@golangci-lint run ./... @golangci-lint run ./...
help: ## Display this help message
@echo "Usage: make [command]"
@echo
@echo "Commands:"
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " %-15s %s\n", $$1, $$2}'
.DEFAULT_GOAL := help
.PHONY: build run dev templ format lint .PHONY: build run dev templ format lint