Minor cleanup

Author: connellr023

README.md

@@ -44,7 +44,12 @@ If these formatters are not used, the CI pipeline will create a commit with the
 
 ### Code Linting
 
-The `frontend` for this project uses [ESLint](https://eslint.org/) for linting. The `backend` uses [GolangCI](https://golangci-lint.run/) for linting.
+The following code linters are required for this project:
+
+- [ESLint](https://eslint.org/) for all frontend code
+- [GolangCI](https://golangci-lint.run/) for all backend code
+
+If these linters are not used, the CI pipeline will fail if linting errors are found.
 
 ## Structure
 
@@ -87,7 +92,7 @@ First, install the **NVIDIA Container Toolkit** by following the instructions [h
 
 First, install GPU support. On Windows it is only available in Docker Desktop via **WSL 2** backend Paravirtualization, to enable it, follow the instructions [here](https://docs.docker.com/desktop/features/gpu/)
 
-#### Starting
+### Starting
 
 Then, run:
 
@@ -139,6 +144,15 @@ To stop all services, run:
 docker-compose -f docker-compose-cpu.yaml down
 ```
 
+### Sample `.env` file
+
+```env
+JWT_SECRET=dev_secret
+SURREALDB_USERNAME=root
+SURREALDB_PASSWORD=root
+REDIS_PASSWORD=password
+```
+
 ### Starting the frontend service
 
 Ensure all dependencies are installed by running in the `web` directory:

build/package/prod/backend.prod.dockerfile

@@ -11,6 +11,10 @@ RUN go mod download
 # Copy the rest of the application source code into the container
 COPY . .
 
+# Copy the .env file into the container
+COPY .env .env
+
+
 # Build the Go application
 RUN CGO_ENABLED=0 GOOS=linux go build -o /app/tokenbase ./cmd/tokenbase
 

cmd/tokenbase/tokenbase.go

@@ -84,10 +84,11 @@ func main() {
 	// Sleep to wait for Docker containers to start.
 	time.Sleep(5 * time.Second)
 
-	// Load in env variables from .env file.
+	// Load in environment variables.
 	err := godotenv.Load(".env")
+
 	if err != nil {
-		panic("Failed to load .env file")
+		panic("failed to load environment variables")
 	}
 
 	// Connect to SurrealDB over the Docker network.

docker-compose-cpu.yaml

@@ -44,8 +44,8 @@ services:
       dockerfile: ./build/package/redis.dockerfile
     ports:
       - "6379:6379"
-    environment:
-      - REDIS_PASSWORD=password
+    env_file:
+      - ./.env
     networks:
       - app-network
 

docker-compose-prod.yaml

@@ -51,8 +51,8 @@ services:
       dockerfile: ./build/package/redis.dockerfile
     ports:
       - "6379:6379"
-    environment:
-      - REDIS_PASSWORD=password
+    env_file:
+      - ./.env
     networks:
       - app-network
 

docker-compose.yaml

@@ -51,8 +51,8 @@ services:
       dockerfile: ./build/package/redis.dockerfile
     ports:
       - "6379:6379"
-    environment:
-      - REDIS_PASSWORD=password
+    env_file:
+      - ./.env
     networks:
       - app-network
 

go.mod

@@ -6,14 +6,14 @@ require (
 	github.com/go-chi/chi/v5 v5.2.1
 	github.com/go-chi/cors v1.2.1
 	github.com/golang-jwt/jwt/v5 v5.2.2
+	github.com/joho/godotenv v1.5.1
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/surrealdb/surrealdb.go v0.3.2
 )
 
 require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
-	github.com/joho/godotenv v1.5.1 // indirect
 	github.com/stretchr/testify v1.10.0 // indirect
 )
 

internal/utils/constants.go

@@ -1,9 +1,5 @@
 package utils
 
-import (
-	"os"
-)
-
 const BackendEndpoint = ":8090"
 
 // Account constraints.
@@ -27,20 +23,8 @@ var (
 	SdbName           = "tokenbaseDB"
 )
 
-func GetSdbUsername() string {
-	return os.Getenv("SDB_USERNAME")
-}
-
-func GetSdbPassword() string {
-	return os.Getenv("SDB_PASSWORD")
-}
-
 // Redis connection details.
 var (
 	RdbDockerEndpoint = "redis:6379"
 	RdbDatabase       = 0
 )
-
-func GetRdbPassword() string {
-	return os.Getenv("RDB_PASSWORD")
-}

internal/utils/env.go

@@ -0,0 +1,19 @@
+package utils
+
+import "os"
+
+func GetJwtSecret() string {
+	return os.Getenv("JWT_SECRET")
+}
+
+func GetSdbUsername() string {
+	return os.Getenv("SURREALDB_USERNAME")
+}
+
+func GetSdbPassword() string {
+	return os.Getenv("SURREALDB_PASSWORD")
+}
+
+func GetRdbPassword() string {
+	return os.Getenv("REDIS_PASSWORD")
+}

internal/utils/jwt.go

@@ -6,12 +6,11 @@ import (
 
 	"github.com/golang-jwt/jwt/v5"
 	"github.com/mitchellh/mapstructure"
-	"os"
 )
 
 var (
 	jwtLifetime  = time.Hour * 24
-	jwtSecretKey = []byte(os.Getenv("JWT_SECRET"))
+	jwtSecretKey = []byte(GetJwtSecret())
 )
 
 // Generates a JWT for a user.