fix: more option added in make file and ORM added

Author: Gauravst

.github/workflows/ci-cd.yml

@@ -0,0 +1,25 @@
+name: Testing Project
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.23.4
+
+      - name: Run tests via Makefile
+        run: make test

.github/workflows/test.yml

@@ -27,4 +27,4 @@ COPY --from=builder /app/got .
 EXPOSE 8080
 
 # Command to run the application.
-CMD ["./go-api-template"]
+CMD ["./got"]

Dockerfile

@@ -12,7 +12,7 @@ PROJECT_NAME_API=got-api
 PROJECT_NAME_CLI=got-cli
 GITHUB_USERNAME=gauravst
 
-# Variables
+# variables
 BINARY_NAME=got
 GO_FILES=$(shell find . -name '*.go' -not -path './vendor/*')
 MIGRATE_PATH=./migrations
@@ -22,89 +22,88 @@ DOCKER_IMAGE_NAME=got
 DOCKER_TAG=latest
 PORT=8080
 
-# Default target
+# default target
 all: build
 
-# Build the application
+# build the application
 build:
 	@echo "Building the application..."
 	go build -o bin/$(BINARY_NAME) cmd/$(PROJECT_NAME)/main.go
 
-# Run the cli application
+# run the api application
 run-api:
 	@echo "Running the application..."
 	go run cmd/$(PROJECT_NAME_API)/main.go
 
-# Run the cli application
+# run the cli application
 run-cli:
 	@echo "Running the application..."
 	go run cmd/$(PROJECT_NAME_CLI)/main.go
 
-# Run tests
+# run tests
 test:
 	@echo "Running tests..."
 	go test -v ./...
 
-# Format code
+# format code
 fmt:
 	@echo "Formatting code..."
 	go fmt ./...
 
-# Clean build artifacts
+# clean build artifacts
 clean:
 	@echo "Cleaning up..."
 	rm -rf bin/
 
-# Install dependencies
+# install dependencies
 deps:
 	@echo "Installing dependencies..."
 	go mod tidy
 
-# Run all up migrations
+# run all up migrations
 migrate-up:
 	migrate -path $(MIGRATE_PATH) -database $(DB_URL) up
 
-# Run all down migrations
+# run all down migrations
 migrate-down:
 	migrate -path $(MIGRATE_PATH) -database $(DB_URL) down
 
-## Build the Docker image
+## build the Docker image
 docker-build:
 	docker build -t $(DOCKER_IMAGE_NAME):$(DOCKER_TAG) .
 
-## Run the Docker container
+## run the Docker container
 docker-run:
 	docker run -p $(PORT):$(PORT) $(DOCKER_IMAGE_NAME):$(DOCKER_TAG)
 
-## Stop the Docker container
+## stop the Docker container
 docker-stop:
 	docker stop $$(docker ps -q --filter ancestor=$(DOCKER_IMAGE_NAME):$(DOCKER_TAG))
 
-## Remove the Docker container
+## remove the Docker container
 docker-rm:
 	docker rm $$(docker ps -a -q --filter ancestor=$(DOCKER_IMAGE_NAME):$(DOCKER_TAG))
 
-## Remove the Docker image
+## remove the Docker image
 docker-rmi:
 	docker rmi $(DOCKER_IMAGE_NAME):$(DOCKER_TAG)
 
-## Clean up Docker resources (stop, remove container, and remove image)
+## clean up Docker resources (stop, remove container, and remove image)
 docker-clean: docker-stop docker-rm docker-rmi
 
-# Combined commands
-
-## Build and run the Go application
+## build and run the Go application
 all: build run
 
-## Build and run the Docker container
+## build and run the Docker container
 docker-all: docker-build docker-run
 
-# Run all checks (format, test, build)
+# run all checks (format, test, build)
 check: fmt test build
 
 # template migrate 
 SHELL := bash
 
+# setup for project
 setup:
 	@bash -c '\
 		echo "Enter your GitHub username :-"; \
@@ -115,6 +114,20 @@ setup:
 		read API_APP; \
 		echo "Do you need CLI App? (y/n) :-"; \
 		read CLI_APP; \
+		echo "Do you need Database? (y/n) :-"; \
+		read DB; \
+		if [ "$$DB" = "y" ]; then \
+			echo "postgres or sqlite? (p/s) :-"; \
+			read DB_TYPE; \
+			echo "Do you need ORM (Gorm)? (y/n) :-"; \
+			read ORM; \
+		fi; \
+		echo "Do you need unit/e2e/integration Testing? (y/n) :-"; \
+		read TESTING; \
+		echo "Do You need github workflow, CI/CD (y/n) :-"; \
+		read WORKFLOW; \
+		echo "Do you need Docker file setup? (y/n) :-"; \
+		read IS_DOCKER; \
 		LOWER_USERNAME=$$(echo $$USERNAME | tr "[:upper:]" "[:lower:]"); \
 		LOWER_PROJECT=$$(echo $$PROJECT | tr "[:upper:]" "[:lower:]"); \
 		NEW_IMPORT=github.com/$$LOWER_USERNAME/$$LOWER_PROJECT; \
@@ -139,6 +152,53 @@ setup:
 			mv $(OLD_CMD_DIR_CLI)/main.go $$NEW_CMD_DIR-cli/main.go; \
 			rm -rf $(OLD_CMD_DIR_CLI); \
 		fi; \
+		if [ "$$DB" = "n" ]; then \
+			echo "Removing database..."; \
+			rm -rf internal/database; \
+		else \
+			if [ "$$ORM" = "y" ]; then \
+				echo "Adding ORM..."; \
+				rm -rf migrations; \
+				rm -f internal/database/database.go; \
+			else \
+				echo "Adding Raw SQL setup"
+				rm -f internal/database/init.go; \
+				rm -f internal/database/postgres.go; \
+				rm -f internal/database/sqlite.go; \
+			fi; \
+			if [ "$$DB_TYPE" = "p" ]; then \
+				if [ "$$ORM" = "y" ]; then \
+					echo "Adding Postgres Db..."; \
+					rm -f internal/database/database.go; \
+				else \
+					# something here
+				fi; \
+			else \
+				if [ "$$ORM" = "y" ]; then \
+					echo "Adding Sqlite"
+				else \
+					# something here
+				fi; \
+			fi; \
+		fi; \
+		if [ "$$TESTING" = "n" ]; then \
+			echo "Removing Testing..."; \
+			rm -rf test; \
+			find . -type f -name '*_test.go' -delete; \
+		fi; \
+		if [ "$$WORKFLOW" = "n" ]; then \
+			echo "Removing workflow..."; \
+			rm -rf .github/workflows; \
+		else \
+			if [ "$$TESTING" = "n" ]; then \
+				rm -f .github/workflows/test.yml; \
+			fi; \
+		fi; \
+		if [ "$$IS_DOCKER" = "n" ]; then \
+			echo "Removing Docker setup..."; \
+			rm -f Dockerfile; \
+			rm -f .dockerignore; \
+		fi; \
 		echo "Replacing imports..."; \
 		find . -type f -name "*.go" -exec sed -i "s|$(OLD_IMPORT)|$$NEW_IMPORT|g" {} +; \
 		find . -type f -name "go.mod" -exec sed -i "s|$(OLD_IMPORT)|$$NEW_IMPORT|g" {} +; \

Makefile

@@ -1,6 +1,6 @@
 # GOT - Go Template
 
-![Version](https://img.shields.io/badge/version-0.1.0--alpha-blue)
+![Version](https://img.shields.io/badge/version-0.2.0--alpha-blue)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 A Production-Ready Go template to kickstart your next Go lang Project.
@@ -18,14 +18,15 @@ A Production-Ready Go template to kickstart your next Go lang Project.
 ## Features
 
 - Database Support
+- ORM Support
 - Docker Integration
 - Makefile Commands
 - CLI Support
 - REST API Ready
 - Database Migrations
 - Environment Config
 - Modular Structure
-- Testing Framework
+- Testing e2e/integration/unit Support
 
 ## Setup
 

README.md

@@ -11,15 +11,26 @@ require (
 	github.com/golang-jwt/jwt/v5 v5.2.1 // indirect
 	github.com/ilyakaznacheev/cleanenv v1.5.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
+	github.com/jackc/pgx/v5 v5.7.5 // indirect
+	github.com/jackc/puddle/v2 v2.2.2 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/joho/godotenv v1.5.1 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
 	github.com/lib/pq v1.10.9 // indirect
+	github.com/mattn/go-sqlite3 v1.14.28 // indirect
 	github.com/spf13/cobra v1.9.1 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
-	golang.org/x/crypto v0.32.0 // indirect
+	golang.org/x/crypto v0.39.0 // indirect
 	golang.org/x/net v0.34.0 // indirect
-	golang.org/x/sys v0.29.0 // indirect
-	golang.org/x/text v0.21.0 // indirect
+	golang.org/x/sync v0.15.0 // indirect
+	golang.org/x/sys v0.33.0 // indirect
+	golang.org/x/text v0.26.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
+	gorm.io/driver/postgres v1.6.0 // indirect
+	gorm.io/driver/sqlite v1.6.0 // indirect
+	gorm.io/gorm v1.30.0 // indirect
 	olympos.io/encoding/edn v0.0.0-20201019073823-d3554ca0b0a3 // indirect
 )