feat: 🎨 add setup with mongodb

add setup with mongodb

add setup with mongodb

Author: yuanyu90221

.github/workflows/go.yml

@@ -0,0 +1,30 @@
+name: Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go-task
+        uses: pnorton5432/setup-task@v1
+        with:
+          task-version: 3.29.1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+          check-latest: true
+      - name: Task Build
+        run: task build
+      - name: Task Build for mage
+        run: task build-gg
+      - name: Test with gg
+        run: ./gg test

.gitignore

@@ -0,0 +1,28 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+bin
+gg
+mage

README.md

@@ -0,0 +1,123 @@
+# golang-with-mongodb-sample
+
+This repository is demo how to use mongodb with golang
+
+## sample
+
+install mongo driver on golang
+
+```shell
+go get go.mongodb.org/mongo-driver/mongo
+```
+
+## setup run tools on Taskfile.yml
+
+```yaml
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - echo "This is task cmd"
+    silent: true
+  
+  build:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+    silent: true
+  run:
+    cmds:
+      - ./bin/main
+    deps:
+      - build
+    silent: true
+
+  build-mage:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o ./mage mage-tools/mage.go
+    silent: true
+  
+  build-gg:
+    cmds:
+      - ./mage -d mage-tools -compile ../gg
+    deps:
+      - build-mage
+    silent: true
+
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+```
+
+## setup test script with mage lib
+
+### main execute file
+
+```golang
+//go:build ignore
+// +build ignore
+
+package main
+
+import (
+	"os"
+
+	"github.com/magefile/mage/mage"
+)
+
+func main() { os.Exit(mage.Main()) }
+```
+
+### setup run script on magefile.go
+
+```golang
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"github.com/magefile/mage/mg"
+	"github.com/magefile/mage/sh"
+)
+
+var Default = Build
+
+// clean the build binary
+func Clean() error {
+	return sh.Rm("bin")
+}
+
+// Creates the binary in the current directory.
+func Build() error {
+	mg.Deps(Clean)
+	if err := sh.Run("go", "mod", "download"); err != nil {
+		return err
+	}
+	return sh.Run("go", "build", "-o", "./bin/server", "./cmd/main.go")
+}
+
+// start the server
+func Launch() error {
+	mg.Deps(Build)
+	err := sh.RunV("./bin/server")
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// run the test
+func Test() error {
+	err := sh.RunV("go", "test", "-v", "./...")
+	if err != nil {
+		return err
+	}
+	return nil
+}
+```

Taskfile.yml

@@ -0,0 +1,40 @@
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - echo "This is task cmd"
+    silent: true
+  
+  build:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o bin/main cmd/main.go
+    silent: true
+  run:
+    cmds:
+      - ./bin/main
+    deps:
+      - build
+    silent: true
+
+  build-mage:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o ./mage mage-tools/mage.go
+    silent: true
+  
+  build-gg:
+    cmds:
+      - ./mage -d mage-tools -compile ../gg
+    deps:
+      - build-mage
+    silent: true
+
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+  

cmd/main.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"context"
+	"log/slog"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/leetcode-golang-classroom/golang-with-mongodb-sample/internal/application"
+	"github.com/leetcode-golang-classroom/golang-with-mongodb-sample/internal/config"
+	mlog "github.com/leetcode-golang-classroom/golang-with-mongodb-sample/internal/logger"
+)
+
+func main() {
+	logger := slog.New(slog.NewJSONHandler(
+		os.Stdout, &slog.HandlerOptions{
+			AddSource: true,
+		},
+	))
+	rootContext := context.WithValue(context.Background(), mlog.CtxKey{}, logger)
+	app, err := application.New(config.AppConfig, rootContext)
+	if err != nil {
+		logger.Error("failed to build app", "error", err)
+		return
+	}
+	ctx, cancel := signal.NotifyContext(rootContext, os.Interrupt, syscall.SIGTERM, syscall.SIGINT)
+	defer cancel()
+	err = app.Start(ctx)
+	if err != nil {
+		logger.Error("failed to start app", "error", err)
+	}
+}

docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  mongo:
+    image: mongo:latest
+    container_name: mongo
+    restart: always
+    ports:
+      - "${MONGO_PORT}:27017"
+    environment:
+      - MONGO_INITDB_ROOT_USERNAME=${MONGO_INITDB_ROOT_USERNAME}
+      - MONGO_INITDB_ROOT_PASSWORD=${MONGO_INITDB_ROOT_PASSWORD}
+      - MONGO_INITDB_DATABASE=${MONGO_DB_NAME}

go.mod

@@ -0,0 +1,66 @@
+module github.com/leetcode-golang-classroom/golang-with-mongodb-sample
+
+go 1.22.4
+
+require (
+	github.com/gin-gonic/gin v1.10.0
+	github.com/magefile/mage v1.15.0
+	github.com/samber/slog-gin v1.13.6
+	github.com/spf13/viper v1.19.0
+	go.mongodb.org/mongo-driver v1.17.1
+)
+
+require (
+	github.com/bytedance/sonic v1.11.9 // indirect
+	github.com/bytedance/sonic/loader v0.1.1 // indirect
+	github.com/cloudwego/base64x v0.1.4 // indirect
+	github.com/cloudwego/iasm v0.2.0 // indirect
+	github.com/fsnotify/fsnotify v1.7.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.4 // indirect
+	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.22.0 // indirect
+	github.com/goccy/go-json v0.10.3 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.17.2 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.8 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/montanaflynn/stats v0.7.1 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/sagikazarmark/locafero v0.4.0 // indirect
+	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
+	github.com/spf13/cast v1.6.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.12 // indirect
+	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
+	github.com/xdg-go/scram v1.1.2 // indirect
+	github.com/xdg-go/stringprep v1.0.4 // indirect
+	github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
+	go.opentelemetry.io/otel v1.29.0 // indirect
+	go.opentelemetry.io/otel/trace v1.29.0 // indirect
+	go.uber.org/atomic v1.9.0 // indirect
+	go.uber.org/multierr v1.9.0 // indirect
+	golang.org/x/arch v0.8.0 // indirect
+	golang.org/x/crypto v0.26.0 // indirect
+	golang.org/x/exp v0.0.0-20230905200255-921286631fa9 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/sys v0.23.0 // indirect
+	golang.org/x/text v0.17.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)