feat(backend): dockerize

Signed-off-by: Aryan Goyal <[email protected]>

.dockerignore

@@ -0,0 +1,4 @@
+tmp
+main
+.env
+chromium

.github/workflows/backend.yml

@@ -0,0 +1,93 @@
+name: Docker
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  push:
+    branches: [ "main" ]
+    # Publish semver tags as releases.
+    tags: [ 'v*.*.*' ]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}/backend
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        uses: sigstore/cosign-installer@59acb6260d9c0ba8f4a2f9d9b48431a222b68e20 #v3.5.0
+        with:
+          cosign-release: 'v2.2.4'
+
+      # Set up BuildKit Docker container builder to be able to build
+      # multi-platform images and export cache
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          file: ./cmd/app/Dockerfile
+
+      # Sign the resulting Docker image digest except on PRs.
+      # This will only write to the public Rekor transparency log when the Docker
+      # repository is public to avoid leaking data.  If you would like to publish
+      # transparency data even for private images, pass --force to cosign below.
+      # https://github.com/sigstore/cosign
+      - name: Sign the published Docker image
+        if: ${{ github.event_name != 'pull_request' }}
+        env:
+          # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
+          TAGS: ${{ steps.meta.outputs.tags }}
+          DIGEST: ${{ steps.build-and-push.outputs.digest }}
+        # This step uses the identity token to provision an ephemeral certificate
+        # against the sigstore community Fulcio instance.
+        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}

cmd/app/Dockerfile

@@ -0,0 +1,18 @@
+FROM golang:alpine3.20 AS base
+
+WORKDIR /app
+
+COPY . .
+
+RUN apk add make
+
+RUN make clean
+RUN go mod download
+RUN make build
+
+FROM alpine:3.20
+COPY --from=base /app/main /app/
+
+WORKDIR /app
+
+CMD [ "./main" ]

internal/infra/constants.go

@@ -1,5 +1,8 @@
 package infra
 
-const PROMPT string = `You are a teacher helping a student in solving leetcode. The problem is "%v". The solution is in "%v" programming language. The student is attempting the solution and has currently a code of %v lines. The student is attempting the follwing solution:"%v". Help the student towards the solution using Socratic teaching questions. If you feel like their solution can be optimized further, give some questions according to the Socratic Teaching method philosophy and at what line of the solution they should be asked. The questions should be insightful and encourage the student towards getting the answer on their own. There should be a maximum of one question per line of code, and the questions should not excede the number of lines.`
+const (
+	PROMPT      string = `You are a teacher helping a student in solving leetcode. The problem is "%v". The solution is in "%v" programming language. The student is attempting the solution and has currently a code of %v lines. The student is attempting the follwing solution:"%v". Help the student towards the solution using Socratic teaching questions. If you feel like their solution can be optimized further, give some questions according to the Socratic Teaching method philosophy and at what line of the solution they should be asked. The questions should be insightful and encourage the student towards getting the answer on their own. There should be a maximum of one question per line of code, and the questions should not excede the number of lines.`
+	DESCRIPTION string = `backend for socratic leetcode, (https://github.com/ary82/socratic-leetcode). Helps you solve leetcode on your own with insightful questions according to the socratic teaching method`
+)
 
 // const PROMPT string = `You are a teacher helping a student in solving leetcode. The problem is "%v". The solution is in "%v" programming language. The student is attempting the solution and has currently a code of %v lines. The student is attempting the follwing solution:"%v". Help the student towards the solution using Socratic teaching questions. If you feel like their solution can be optimized further, give some questions according to the Socratic Teaching method philosophy and at what line of the solution they should be asked. Line numbers of the code should start at 0. The questions should be insightful and encourage the student towards getting the answer on their own. There should be a maximum of one question per line of code, and the questions should not excede the number of lines.`

internal/infra/server.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/compress"
+	"github.com/gofiber/fiber/v2/middleware/favicon"
 	"github.com/gofiber/fiber/v2/middleware/logger"
 	"github.com/google/generative-ai-go/genai"
 )
@@ -29,8 +30,10 @@ func NewServer(app *fiber.App, textModel *genai.GenerativeModel) *Server {
 func (s *Server) registerRoutes() {
 	s.App.Use(logger.New())
 	s.App.Use(compress.New())
+	s.App.Use(favicon.New())
 
 	s.App.Post("/generate", s.getSocraticQuestions)
+	s.App.Get("/", s.description)
 }
 
 func (s *Server) getSocraticQuestions(ctx *fiber.Ctx) error {
@@ -74,3 +77,9 @@ func (s *Server) getSocraticQuestions(ctx *fiber.Ctx) error {
 
 	return ctx.Status(fiber.StatusOK).JSON(resJson)
 }
+
+func (s *Server) description(ctx *fiber.Ctx) error {
+	return ctx.Status(fiber.StatusOK).JSON(fiber.Map{
+		"description": DESCRIPTION,
+	})
+}