Update environment variables and add compression middleware

.env.template

@@ -1,8 +1,11 @@
 # App's running environment
-NODE_ENV=
+NODE_ENV=development
 
 # App's running port
-PORT=
+PORT=8080
+
+# Cors Origin URL
+CORS_ORIGIN=""
 
 # App's public path
 PUBLIC_PATH="/"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package.json

@@ -11,13 +11,15 @@
     "lint:fix": "eslint --fix --ext .ts,.js src/",
     "format": "prettier --write 'src/**/*.{ts,js,json}'",
     "check-format": "prettier --check 'src/**/*.{ts,js,json}'",
+    "prepare": "husky install",
     "docker-prod": "docker-compose up --build",
     "docker-stop": "docker-compose down"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "compression": "^1.7.4",
     "cors": "^2.8.5",
     "crypto": "^1.0.1",
     "dotenv": "^16.3.1",
@@ -27,6 +29,7 @@
   },
   "devDependencies": {
     "@tsconfig/node-lts-strictest-esm": "^18.12.1",
+    "@types/compression": "^1.7.5",
     "@types/cors": "^2.8.17",
     "@types/dotenv": "^8.2.0",
     "@types/express": "^4.17.21",
@@ -36,11 +39,18 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.2",
     "eslint-plugin-simple-import-sort": "^10.0.0",
+    "husky": "^8.0.3",
     "lint-staged": "^15.2.0",
     "nodemon": "^3.0.2",
     "prettier": "^3.1.1",
     "rimraf": "^5.0.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
+  },
+  "lint-staged": {
+    "**/*.{js,jsx,ts,tsx}": [
+      "npx prettier --write",
+      "npx eslint --fix"
+    ]
   }
 }

src/server.ts

@@ -1,18 +1,23 @@
+import compression from "compression";
 import cors from "cors";
 import express, { Express } from "express";
 import helmet from "helmet";
 import { pino } from "pino";
 import { pinoHttp } from "pino-http";
 
 import { middlewares } from "./middleware";
+import compressFilter from "./utils/compress-filter";
+import { getCorsOrigin } from "./utils/env";
 
 const logger = pino({ name: "server start" });
 const app: Express = express();
+const cors_origin = getCorsOrigin();
 
 // Setup Middlewares
-app.use(cors({ credentials: true }));
+app.use(cors({ origin: [cors_origin], credentials: true }));
 app.use(pinoHttp({ logger }));
 app.use(helmet());
+app.use(compression({ filter: compressFilter }));
 app.use(middlewares());
 
 export { app, logger };

src/utils/compress-filter/index.ts

@@ -0,0 +1,20 @@
+import compression from "compression";
+import type { Request, Response } from "express";
+
+/**
+ * Filter Function for the compression middleware
+ * @param req HTTPs Request
+ * @param res HTTPs Response
+ * @returns Returns false if request header contains x-no-compression
+ */
+function compressFilter(req: Request, res: Response): boolean {
+  if (req.headers["x-no-compression"]) {
+    // don't compress responses with this request header
+    return false;
+  }
+
+  // fallback to standard filter function
+  return compression.filter(req, res);
+}
+
+export default compressFilter;

src/utils/env/index.ts

@@ -1,5 +1,13 @@
+import * as dotenv from "dotenv";
+import path from "path";
+
+dotenv.config({
+  path: path.resolve(__dirname, "../../.env"),
+});
+
 export const getPort = () => getEnvVar<number>("PORT", "number");
 export const getNodeEnv = () => getEnvVar<string>("NODE_ENV", "string");
+export const getCorsOrigin = () => getEnvVar<string>("CORS_ORIGIN", "string");
 
 function getEnvVar<T extends string | number>(key: string, type: "string" | "number"): T {
   const value = process.env[key];