feat: add health endpoint

README.md

@@ -9,7 +9,7 @@
 
 # Getting Started
 
-1. Start the database and app. The db container will create table automatically.
+1. Start the database and app. The db container will create table automatically according to [here](./db_migration/init.sql).
 
 ```sh
 docker compose up -d
@@ -27,14 +27,14 @@ docker compose exec app bash
 deno task db:migration
 ```
 
-4. Start calling the API
+4. test the API using endpoint http://localhost:8080/health
 
 # Testing
 
 1. Enter app container as above
 2. Run `deno task test`
 
-> [!WARNING]  
+> [!WARNING]
 > Run test will TRUNCATE all the tables, make sure to use dev database.
 
 # Remark

constants.ts

@@ -14,4 +14,5 @@ export const ROUTES = {
   SIGNUP: "/signup",
   ORDER_CREATE: "/orders",
   MY_ORDERS: "/orders/me",
+  HEALTH: "/health",
 };

docker-compose.yaml

@@ -5,6 +5,8 @@ services:
       args:
         - PORT=8080
     env_file: .env.docker_local
+    ports:
+      - 8080:8080
 
   database:
     image: mysql
@@ -18,7 +20,7 @@ services:
       - 3306:3306
     volumes:
       # Create tables
-      - ./db_migration:/docker-entrypoint-initdb.d
+      - ./db_migration/init.sql:/docker-entrypoint-initdb.d/init.sql
     command:
       [
         "mysqld",

main.ts

@@ -48,9 +48,9 @@ router.post(ROUTES.SIGNUP, async (context) => {
     const payload = SignupValidator.parse(body);
 
     await userService.signup(payload.username, payload.password);
-    const redirect_url = `${getEnv("APP_URL")}:${
-      getEnv("PORT")
-    }${ROUTES.LOGIN}`;
+    const redirect_url = `${getEnv("APP_URL")}:${getEnv(
+      "PORT",
+    )}${ROUTES.LOGIN}`;
 
     helper.setAPIResponse<SignupResponseData>(context, {
       success: true,
@@ -103,15 +103,20 @@ router.get(ROUTES.MY_ORDERS, authMiddleware, async (context) => {
   });
 });
 
+router.get(ROUTES.HEALTH, (context) => {
+  helper.setAPIResponse(context, {
+    success: true,
+  });
+});
+
 app.use(router.routes());
 app.use(router.allowedMethods());
 
 if (import.meta.main) {
   const port = parseInt(helper.getEnv("PORT"));
 
-  app.addEventListener(
-    "listen",
-    () => console.log(`Server listensing on PORT ${port}`),
+  app.addEventListener("listen", () =>
+    console.log(`Server listensing on PORT ${port}`),
   );
   await app.listen({ port });