Add basic health check

Author: patrick91

backend/app/api/routes/utils.py

@@ -24,3 +24,8 @@ def test_email(email_to: EmailStr) -> Message:
         html_content=email_data.html_content,
     )
     return Message(message="Test email sent")
+
+
+@router.get("/health-check/")
+async def health_check() -> bool:
+    return True

docker-compose.yml

@@ -63,6 +63,12 @@ services:
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD?Variable not set}
       - SENTRY_DSN=${SENTRY_DSN}
 
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost/api/v1/utils/health-check/"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
     build:
       context: ./backend
       args:

frontend/src/client/services.ts

@@ -386,6 +386,18 @@ export class UtilsService {
       },
     })
   }
+
+  /**
+   * Health Check
+   * @returns boolean Successful Response
+   * @throws ApiError
+   */
+  public static healthCheck(): CancelablePromise<boolean> {
+    return __request(OpenAPI, {
+      method: "GET",
+      url: "/api/v1/utils/health-check/",
+    })
+  }
 }
 
 export type TDataReadItems = {