Initial commit

Author: MitulShah1

.env.example

@@ -0,0 +1,27 @@
+# ───────────────────────────────────────────────
+# 🌟 Application Configuration
+# ───────────────────────────────────────────────
+SERVER_PORT=8080
+DEBUG=true
+DISABLE_LOGS=false
+LOG_FORMAT=json
+LOG_CALLER=true
+LOG_STACKTRACE=false
+
+# ───────────────────────────────────────────────
+# 🌟 Database Configuration
+# ───────────────────────────────────────────────
+DB_HOST=db
+DB_PORT=3306
+DB_USER=myuser
+DB_PASSWORD=mypassword
+DB_NAME=mydatabase
+
+# ───────────────────────────────────────────────
+# 🌟 Golang Tools Versions
+# ───────────────────────────────────────────────
+SWAG_VERSION=v1.16.4
+MIGRATE_VERSION=v4.16.2
+LINT_VERSION=v1.59.1
+IMPORTS_VERSION=v0.24.0
+VULN_VERSION=v1.1.3

.github/workflows/go.yml

@@ -22,7 +22,7 @@ jobs:
         go-version: '1.21'
 
     - name: Install dependencies
-      run: go get .
+      run: go get ./...
 
     - name: Build
       run: go build -v ./...

.gitignore

@@ -23,3 +23,10 @@ go.work.sum
 
 # env file
 .env
+
+#ignore build
+build/*
+/bkp
+
+#ignore test coverage
+.coverage

Dockerfile

@@ -0,0 +1,106 @@
+# ───────────────────────────────────────────────────────────
+# 🌟 STAGE 1: BUILD GO APPLICATION
+# ───────────────────────────────────────────────────────────
+FROM golang:1.21 AS builder
+
+# Accept build arguments
+ARG SERVER_PORT
+ARG DB_HOST
+ARG DB_PORT
+ARG DB_USER
+ARG DB_PASSWORD
+ARG DB_NAME
+ARG DEBUG
+ARG DISABLE_LOGS
+ARG LOG_FORMAT
+ARG LOG_CALLER
+ARG LOG_STACKTRACE
+ARG SWAG_VERSION
+ARG MIGRATE_VERSION
+ARG LINT_VERSION
+ARG IMPORTS_VERSION
+ARG VULN_VERSION
+
+# Set environment variables for versions (same as Makefile)
+ENV SERVER_PORT=$SERVER_PORT
+ENV DB_HOST=$DB_HOST
+ENV DB_PORT=$DB_PORT
+ENV DB_USER=$DB_USER
+ENV DB_PASSWORD=$DB_PASSWORD
+ENV DB_NAME=$DB_NAME
+ENV DEBUG=$DEBUG
+ENV DISABLE_LOGS=$DISABLE_LOGS
+ENV LOG_FORMAT=$LOG_FORMAT
+ENV LOG_CALLER=$LOG_CALLER
+ENV LOG_STACKTRACE=$LOG_STACKTRACE
+ARG SWAG_VERSION=$SWAG_VERSION
+ARG MIGRATE_VERSION=$MIGRATE_VERSION
+ARG LINT_VERSION=$LINT_VERSION
+ARG IMPORTS_VERSION=$IMPORTS_VERSION
+ARG VULN_VERSION=$VULN_VERSION
+
+# Set the working directory inside the container
+WORKDIR /app
+
+# Copy Go modules manifests
+COPY go.mod go.sum ./
+
+# Download Go dependencies
+RUN go mod tidy && go mod download
+
+# Install Swagger, GolangCI-Lint, GoImports, and Govulncheck
+RUN go install github.com/swaggo/swag/cmd/swag@${SWAG_VERSION} && \
+    go install golang.org/x/tools/cmd/goimports@${IMPORTS_VERSION} && \
+    go install golang.org/x/vuln/cmd/govulncheck@${VULN_VERSION} && \
+    go install github.com/golangci/golangci-lint/cmd/golangci-lint@${LINT_VERSION}
+
+# ───────────────────────────────────────────────────────────
+# ✅ INSTALL `golang-migrate` USING OFFICIAL METHOD
+# ───────────────────────────────────────────────────────────
+RUN curl -L https://github.com/golang-migrate/migrate/releases/download/${MIGRATE_VERSION}/migrate.linux-amd64.tar.gz -o migrate.tar.gz && \
+    tar -xvf migrate.tar.gz && \
+    mv migrate /usr/local/bin/migrate && \
+    chmod +x /usr/local/bin/migrate && \
+    rm -f migrate.tar.gz
+
+# Copy the entire project into the container
+COPY . .
+
+# 🔥 Ensure `/app/build/` exists
+RUN mkdir -p /app/build
+
+# Generate Swagger documentation
+RUN make generate_docs
+
+# 🔥 Build the Go application using Makefile
+RUN make build
+
+# ───────────────────────────────────────────────────────────
+# 🌟 STAGE 2: CREATE A SMALLER FINAL IMAGE
+# ───────────────────────────────────────────────────────────
+FROM debian:bullseye-slim
+
+# Set the working directory
+WORKDIR /app
+
+# Install dependencies required to run the app
+RUN apt-get update && apt-get install -y ca-certificates curl && \
+    rm -rf /var/lib/apt/lists/*
+
+# Copy the compiled Go binary from the builder stage
+COPY --from=builder /app/build/server /app/server
+
+# Copy the Swagger docs to serve them later
+COPY --from=builder /app/docs /app/docs
+
+# Copy the migration files
+COPY --from=builder /app/package/database/migrations /app/migrations
+
+# Copy the migrate tool from the builder stage
+COPY --from=builder /usr/local/bin/migrate /usr/local/bin/migrate
+
+# Expose the application port
+EXPOSE ${SERVER_PORT}
+
+# Run the application
+CMD ["/app/server"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mitul Shah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.