Merge pull request #36 from gbrayhan/update-technologies

Upgrade Docker setup and clean up project configurations

Author: gbrayhan

.env.example

@@ -0,0 +1,16 @@
+POSTGRES_DB=boilerplate_go
+POSTGRES_USER=appuser
+POSTGRES_PASSWORD=youShouldChangeThisPassword
+
+DB_HOST=postgres
+DB_PORT=5432
+DB_NAME=boilerplate_go
+DB_USER=appuser
+DB_PASS=youShouldChangeThisPassword
+
+JWT_ACCESS_SECRET=accesskeyyoumayneedtochangeit
+JWT_ACCESS_TIME_MINUTE=10
+JWT_REFRESH_SECRET=refreshkeyyoumayneedtochangeit
+JWT_REFRESH_TIME_HOUR=10
+
+SERVER_PORT=8080

.gitignore

@@ -1,8 +1,11 @@
 # IDE Folders and Files
 .idea
 .DS_Store
+.env
 
 
+*.txt
+*.log
 
 microservices
 config.json

Dockerfile

@@ -1,12 +1,20 @@
-FROM golang:1.20 AS builder
+FROM golang:1.24-alpine AS builder
+
 WORKDIR /srv/go-app
+
+COPY go.mod go.sum ./
+RUN go mod download
+
 COPY . .
-RUN go build -o microservice
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 \
+    go build -a -installsuffix cgo -o microservice .
 
+FROM gcr.io/distroless/static:nonroot
 
-FROM golang:1.20
 WORKDIR /srv/go-app
-#COPY --from=builder /srv/go-app/other-archives ./other-archives/
+
 COPY --from=builder /srv/go-app/microservice .
 
+USER nonroot:nonroot
+
 CMD ["./microservice"]

README.md

@@ -25,7 +25,7 @@ git clone https://github.com/gbrayhan/microservices-go
 
     git clone https://github.com/gbrayhan/microservices-go
     cd microservices-go
-    cp config.json.example config.json
+    cp .env.example .env
     docker-compose up  --build  -d
 
 ## Table of Contents
@@ -41,16 +41,15 @@ git clone https://github.com/gbrayhan/microservices-go
 
 ## Features
 
-- **Golang v1.21**: Stable version of go
+- **Golang v1.24.2**: Stable version of go
 - **Framework**: A stable version of [gin-go](https://github.com/gin-gonic/gin)
 - **Token Security**: with [JWT](https://jwt.io)
-- **SQL databaseSQL**: [MariaDB](https://mariadb.org/) using internal sql package of
+- **SQL databaseSQL**: [Postgresql](https://www.postgresql.org/) using internal sql package of
   go [sql](https://golang.org/pkg/databaseSQL/sql/)
 - **Testing**: unit and integration tests using package of go [testing](https://golang.org/pkg/testing/)
 - **API documentation**: with [swaggo](https://github.com/swaggo/swag) @latest version that is a go implementation
   of [swagger](https://swagger.io/)
 - **Dependency management**: with [go modules](https://golang.org/ref/mod)
-- **Environment variables**: using [viper](https://github.com/spf13/viper)
 - **Docker support**
 - **Code quality**: with [CodeFactor](https://www.codefactor.io/) and [Codacy](https://www.codacy.com/)
 - **Linting**: with [golangci-lint](https://golangci-lint.run/usage/install/) an implementation of a Golang linter

docker-compose.yml

@@ -1,58 +1,45 @@
-version: '3'
+version: "3.9"
+
 services:
-  go-microservice:
-    build: .
-    image: go-microservice
-    # these are the environment variables that will be passed to the container at runtime and will be used in the application
-    environment:
-      - DB_HOST=mysqldb
-      - DB_NAME=boilerplate_go
-      - DB_PASS=youShouldChangeThisPassword
-      - DB_PORT=3306
-      - DB_USER=appuser
-      - JWT_ACCESS_SECRET=accesskeyyoumayneedtochangeit
-      - JWT_ACCESS_TIME_MINUTE=10
-      - JWT_REFRESH_SECRET=refreshkeyyoumayneedtochangeit
-      - JWT_REFRESH_TIME_HOUR=10
-      - SERVER_PORT=8080
-    ports:
-      - '8080:8080'
-    restart: on-failure
-    depends_on:
-      - mysqldb
-    #volumes:
-    #  - .:/srv/go-app
-    networks:
-      - go-network
-  mysqldb:
-    platform: linux/x86_64
-    image: mysql:8.0
+  postgres:
+    image: postgres:17.4
     restart: always
+    env_file:
+      - .env
     environment:
-      MYSQL_DATABASE: 'boilerplate_go'
-      # Password for root access
-      MYSQL_ROOT_PASSWORD: 'youShouldChangeThisPassword'
-      MYSQL_HOST: "%" # Allow connections from outside the container
-      # So you don't have to use root, but you can if you like
-      MYSQL_USER: 'appuser'
-      # You can use whatever password you like
-      MYSQL_PASSWORD: 'youShouldChangeThisPassword'
+      - POSTGRES_DB=${POSTGRES_DB}
+      - POSTGRES_USER=${POSTGRES_USER}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER}"]
+      interval: 10s
+      timeout: 5s
+      start_period: 30s
+      retries: 5
     ports:
-      # <Port exposed> : < MySQL Port running inside container>
-      - '33006:3306'
-    expose:
-      # Opens port 3306 on the container
-      - '3306'
-      # Where our data will be persisted
+      - "5432:5432"
     volumes:
-      - ./docker/scripts/schema.sql:/docker-entrypoint-initdb.d/setup.sql
-      - dbdata:/var/lib/mysql
+      - pgdata:/var/lib/postgresql/data
+    networks:
+      - go-network
 
+  go-microservice:
+    build:
+      context: .
+    image: go-microservice
+    restart: on-failure
+    env_file:
+      - .env
+    ports:
+      - "8080:8080"
+    depends_on:
+      postgres:
+        condition: service_healthy
     networks:
       - go-network
 
 volumes:
-  dbdata:
+  pgdata:
 
 networks:
   go-network:

docker/scripts/schema.sql

@@ -1,7 +1,6 @@
 module github.com/gbrayhan/microservices-go
 
-go 1.21
-toolchain go1.24.1
+go 1.24.2
 
 require (
 	github.com/gin-contrib/cors v1.6.0
@@ -12,8 +11,8 @@ require (
 	github.com/swaggo/gin-swagger v1.6.0
 	github.com/swaggo/swag v1.16.2
 	golang.org/x/crypto v0.35.0
-	gorm.io/driver/mysql v1.5.2
-	gorm.io/gorm v1.25.5
+	gorm.io/driver/postgres v1.5.11
+	gorm.io/gorm v1.25.10
 )
 
 require (
@@ -30,8 +29,11 @@ require (
 	github.com/go-openapi/swag v0.22.8 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-sql-driver/mysql v1.7.1 // indirect
 	github.com/goccy/go-json v0.10.2 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
+	github.com/jackc/pgx/v5 v5.5.5 // indirect
+	github.com/jackc/puddle/v2 v2.2.1 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
@@ -48,6 +50,7 @@ require (
 	github.com/ugorji/go/codec v1.2.12 // indirect
 	golang.org/x/arch v0.7.0 // indirect
 	golang.org/x/net v0.36.0 // indirect
+	golang.org/x/sync v0.11.0 // indirect
 	golang.org/x/sys v0.30.0 // indirect
 	golang.org/x/text v0.22.0 // indirect
 	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect

go.mod

@@ -41,16 +41,21 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn
 github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
 github.com/go-playground/validator/v10 v10.19.0 h1:ol+5Fu+cSq9JD7SoSqe04GMI92cbn0+wvQ3bZ8b/AU4=
 github.com/go-playground/validator/v10 v10.19.0/go.mod h1:dbuPbCMFw/DrkbEynArYaCwl3amGuJotoKCe95atGMM=
-github.com/go-sql-driver/mysql v1.7.0/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
-github.com/go-sql-driver/mysql v1.7.1 h1:lUIinVbN1DY0xBg0eMOzmmtGoHwWBbvnWubQUrtU8EI=
-github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
 github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
 github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
 github.com/golang-jwt/jwt/v4 v4.5.2 h1:YtQM7lnr8iZ+j5q71MGKkNw9Mn7AjHM68uc9g5fXeUI=
 github.com/golang-jwt/jwt/v4 v4.5.2/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
+github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
+github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
+github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
+github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
+github.com/jackc/pgx/v5 v5.5.5 h1:amBjrZVmksIdNjxGW/IiIMzxMKZFelXbUoPNb+8sjQw=
+github.com/jackc/pgx/v5 v5.5.5/go.mod h1:ez9gk+OAat140fv9ErkZDYFWmXLfV+++K0uAOiwgm1A=
+github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
+github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
 github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
 github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
 github.com/jinzhu/now v1.1.5 h1:/o9tlHleP7gOFmsnYNz3RGnqzefHA47wQpKrrdTIwXQ=
@@ -158,10 +163,9 @@ gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EV
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gorm.io/driver/mysql v1.5.2 h1:QC2HRskSE75wBuOxe0+iCkyJZ+RqpudsQtqkp+IMuXs=
-gorm.io/driver/mysql v1.5.2/go.mod h1:pQLhh1Ut/WUAySdTHwBpBv6+JKcj+ua4ZFx1QQTBzb8=
-gorm.io/gorm v1.25.2-0.20230530020048-26663ab9bf55/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
-gorm.io/gorm v1.25.5 h1:zR9lOiiYf09VNh5Q1gphfyia1JpiClIWG9hQaxB/mls=
-gorm.io/gorm v1.25.5/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
+gorm.io/driver/postgres v1.5.11 h1:ubBVAfbKEUld/twyKZ0IYn9rSQh448EdelLYk9Mv314=
+gorm.io/driver/postgres v1.5.11/go.mod h1:DX3GReXH+3FPWGrrgffdvCk3DQ1dwDPdmbenSkweRGI=
+gorm.io/gorm v1.25.10 h1:dQpO+33KalOA+aFYGlK+EfxcI5MbO7EP2yYygwh9h+s=
+gorm.io/gorm v1.25.10/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
 nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYmp6pbG50=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=