[add] Base controller (fix #8)

[fix] some Render deployment errors

Author: TechQuery

package.json

@@ -21,6 +21,7 @@
         "@koa/cors": "^5.0.0",
         "@koa/multer": "^3.0.2",
         "@koa/router": "^12.0.1",
+        "@octokit/openapi-types": "^22.2.0",
         "class-transformer": "^0.5.1",
         "class-validator": "^0.14.1",
         "cross-env": "^7.0.3",
@@ -33,6 +34,7 @@
         "koa-mount": "^4.0.0",
         "koa2-swagger-ui": "^5.10.0",
         "koagger": "^0.3.0",
+        "marked": "^14.0.0",
         "mobx-restful": "^1.0.0",
         "pg": "^8.12.0",
         "pg-connection-string": "^2.6.4",
@@ -44,7 +46,6 @@
         "web-utility": "^4.4.0"
     },
     "devDependencies": {
-        "@octokit/openapi-types": "^22.2.0",
         "@types/jsonwebtoken": "^9.0.6",
         "@types/koa": "^2.15.0",
         "@types/koa-logger": "^3.1.5",
@@ -70,7 +71,7 @@
         "*.{md,json,yml,ts}": "prettier --write"
     },
     "scripts": {
-        "prepare": "husky",
+        "prepare": "husky || true",
         "dev": "ts-node-dev source/",
         "test": "lint-staged",
         "build": "rm -rf dist/ type/*.d.ts  &&  tsc  &&  mv dist/model/*.d.ts type/",

pnpm-lock.yaml

@@ -0,0 +1,34 @@
+import { marked } from 'marked';
+import {
+    Get,
+    HeaderParam,
+    HttpCode,
+    JsonController
+} from 'routing-controllers';
+
+import { isProduct } from '../utility';
+
+@JsonController()
+export class BaseController {
+    static entryOf(host: string) {
+        host = 'http://' + host;
+
+        return `
+- HTTP served at ${host}
+- Swagger API served at ${host}/docs/
+- Swagger API exposed at ${host}/docs/spec
+${isProduct ? '' : `- Mock API served at ${host}/mock/`}
+`;
+    }
+
+    @Get('/_health')
+    @HttpCode(200)
+    getHealthStatus() {
+        return '';
+    }
+
+    @Get()
+    getIndex(@HeaderParam('host') host: string) {
+        return `<pre>${marked(BaseController.entryOf(host))}</pre>`;
+    }
+}

source/controller/Base.ts

@@ -2,13 +2,15 @@ import type {} from 'koa2-swagger-ui';
 import { createAPI } from 'koagger';
 
 import { isProduct } from '../utility';
+import { BaseController } from './Base';
 import { UserController } from './User';
 import { OauthController } from './OAuth';
 import { ActivityLogController } from './ActivityLog';
 import { HackathonController } from './Hackathon';
 import { StaffController } from './Staff';
 import { EnrollmentController } from './Enrollment';
 
+export * from './Base';
 export * from './User';
 export * from './OAuth';
 export * from './ActivityLog';
@@ -24,6 +26,7 @@ export const { swagger, mocker, router } = createAPI({
         ActivityLogController,
         EnrollmentController,
         HackathonController,
-        StaffController
+        StaffController,
+        BaseController
     ]
 });

source/controller/index.ts

@@ -6,11 +6,17 @@ import jwt from 'koa-jwt';
 import KoaLogger from 'koa-logger';
 import { useKoaServer } from 'routing-controllers';
 
-import { mocker, router, swagger, UserController } from './controller';
+import {
+    BaseController,
+    mocker,
+    router,
+    swagger,
+    UserController
+} from './controller';
 import { dataSource } from './model';
 import { APP_SECRET, isProduct, PORT } from './utility';
 
-const HOST = `http://localhost:${PORT}`,
+const HOST = `localhost:${PORT}`,
     app = new Koa()
         .use(KoaLogger())
         .use(swagger({ exposeSpec: true }))
@@ -29,12 +35,7 @@ console.time('Server boot');
 
 dataSource.initialize().then(() =>
     app.listen(PORT, () => {
-        console.log(`
-HTTP served at ${HOST}
-Swagger API served at ${HOST}/docs/
-Swagger API exposed at ${HOST}/docs/spec`);
-
-        if (!isProduct) console.log(`Mock API served at ${HOST}/mock/\n`);
+        console.log(BaseController.entryOf(HOST));
 
         console.timeEnd('Server boot');
     })