typescript-express-starter 8.0.2 → 8.1.7

package/lib/prisma/.env.development.local

@@ -0,0 +1,16 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DATABASE_URL= mysql://root:password@localhost:3306/test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/prisma/.env.production.local

@@ -0,0 +1,16 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DATABASE_URL= mysql://root:password@localhost:3306/test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = combined
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = your.domain.com
+CREDENTIALS = true

package/lib/prisma/.env.test.local

@@ -0,0 +1,16 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DATABASE_URL= mysql://root:password@localhost:3306/test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/prisma/.swcrc

@@ -21,6 +21,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@dtos/*": ["dtos/*"],
       "@exceptions/*": ["exceptions/*"],

package/lib/prisma/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/prisma/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",
@@ -27,7 +27,6 @@
     "class-transformer": "^0.4.0",
     "class-validator": "^0.13.1",
     "compression": "^1.7.4",
-    "config": "^3.3.6",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
     "dotenv": "^10.0.0",
@@ -47,7 +46,6 @@
     "@swc/core": "^1.2.108",
     "@types/bcrypt": "^5.0.0",
     "@types/compression": "^1.7.1",
-    "@types/config": "^0.0.39",
     "@types/cookie-parser": "^1.4.2",
     "@types/cors": "^2.8.11",
     "@types/dotenv": "^8.2.0",

package/lib/prisma/src/app.ts

@@ -1,5 +1,3 @@
-import '@/index';
-import config from 'config';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
@@ -9,19 +7,20 @@ import hpp from 'hpp';
 import morgan from 'morgan';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
+import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
 import { Routes } from '@interfaces/routes.interface';
 import errorMiddleware from '@middlewares/error.middleware';
 import { logger, stream } from '@utils/logger';
 
 class App {
   public app: express.Application;
-  public port: string | number;
   public env: string;
+  public port: string | number;
 
   constructor(routes: Routes[]) {
     this.app = express();
-    this.port = process.env.PORT || 3000;
-    this.env = process.env.NODE_ENV || 'development';
+    this.env = NODE_ENV || 'development';
+    this.port = PORT || 3000;
 
     this.initializeMiddlewares();
     this.initializeRoutes(routes);
@@ -43,8 +42,8 @@ class App {
   }
 
   private initializeMiddlewares() {
-    this.app.use(morgan(config.get('log.format'), { stream }));
-    this.app.use(cors({ origin: config.get('cors.origin'), credentials: config.get('cors.credentials') }));
+    this.app.use(morgan(LOG_FORMAT, { stream }));
+    this.app.use(cors({ origin: ORIGIN, credentials: CREDENTIALS }));
     this.app.use(hpp());
     this.app.use(helmet());
     this.app.use(compression());

package/lib/prisma/src/config/index.ts

@@ -0,0 +1,5 @@
+import { config } from 'dotenv';
+config({ path: `.env.${process.env.NODE_ENV || 'development'}.local` });
+
+export const CREDENTIALS = process.env.CREDENTIALS === 'true';
+export const { NODE_ENV, PORT, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;

package/lib/prisma/src/middlewares/auth.middleware.ts

@@ -1,7 +1,7 @@
-import config from 'config';
 import { NextFunction, Response } from 'express';
 import { verify } from 'jsonwebtoken';
 import { PrismaClient } from '@prisma/client';
+import { SECRET_KEY } from '@config';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
 
@@ -10,7 +10,7 @@ const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFun
     const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
-      const secretKey: string = config.get('secretKey');
+      const secretKey: string = SECRET_KEY;
       const verificationResponse = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userId = verificationResponse.id;
 

package/lib/prisma/src/server.ts

@@ -1,5 +1,3 @@
-import 'dotenv/config';
-import '@/index';
 import App from '@/app';
 import AuthRoute from '@routes/auth.route';
 import IndexRoute from '@routes/index.route';

package/lib/prisma/src/services/auth.service.ts

@@ -1,7 +1,7 @@
 import { compare, hash } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
 import { PrismaClient, User } from '@prisma/client';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
@@ -48,7 +48,7 @@ class AuthService {
 
   public createToken(user: User): TokenData {
     const dataStoredInToken: DataStoredInToken = { id: user.id };
-    const secretKey: string = config.get('secretKey');
+    const secretKey: string = SECRET_KEY;
     const expiresIn: number = 60 * 60;
 
     return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };

package/lib/prisma/src/utils/logger.ts

@@ -1,11 +1,11 @@
-import config from 'config';
 import { existsSync, mkdirSync } from 'fs';
 import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
 
 // logs dir
-const logDir: string = join(__dirname, config.get('log.dir'));
+const logDir: string = join(__dirname, LOG_DIR);
 
 if (!existsSync(logDir)) {
   mkdirSync(logDir);

package/lib/prisma/tsconfig.json

@@ -22,6 +22,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@dtos/*": ["dtos/*"],
       "@exceptions/*": ["exceptions/*"],

package/lib/routing-controllers/.env.development.local

@@ -0,0 +1,13 @@
+# PORT
+PORT = 3000
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/routing-controllers/.env.production.local

@@ -0,0 +1,13 @@
+# PORT
+PORT = 3000
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = combined
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = your.domain.com
+CREDENTIALS = true

package/lib/routing-controllers/.env.test.local

@@ -0,0 +1,13 @@
+# PORT
+PORT = 3000
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/routing-controllers/.swcrc

@@ -21,6 +21,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@dtos/*": ["dtos/*"],
       "@exceptions/*": ["exceptions/*"],

package/lib/routing-controllers/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/routing-controllers/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",
@@ -21,7 +21,6 @@
     "class-validator": "^0.13.1",
     "class-validator-jsonschema": "^3.0.2",
     "compression": "^1.7.4",
-    "config": "^3.3.6",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
     "dotenv": "^10.0.0",
@@ -43,7 +42,6 @@
     "@swc/core": "^1.2.108",
     "@types/bcrypt": "^5.0.0",
     "@types/compression": "^1.7.1",
-    "@types/config": "^0.0.39",
     "@types/cookie-parser": "^1.4.2",
     "@types/cors": "^2.8.11",
     "@types/dotenv": "^8.2.0",

package/lib/routing-controllers/src/app.ts

@@ -1,10 +1,8 @@
 import 'reflect-metadata';
-import '@/index';
 import { defaultMetadataStorage } from 'class-transformer';
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
-import config from 'config';
 import express from 'express';
 import helmet from 'helmet';
 import hpp from 'hpp';
@@ -12,18 +10,19 @@ import morgan from 'morgan';
 import { useExpressServer, getMetadataArgsStorage } from 'routing-controllers';
 import { routingControllersToSpec } from 'routing-controllers-openapi';
 import swaggerUi from 'swagger-ui-express';
+import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
 import errorMiddleware from '@middlewares/error.middleware';
 import { logger, stream } from '@utils/logger';
 
 class App {
   public app: express.Application;
-  public port: string | number;
   public env: string;
+  public port: string | number;
 
   constructor(Controllers: Function[]) {
     this.app = express();
-    this.port = process.env.PORT || 3000;
-    this.env = process.env.NODE_ENV || 'development';
+    this.env = NODE_ENV || 'development';
+    this.port = PORT || 3000;
 
     this.initializeMiddlewares();
     this.initializeRoutes(Controllers);
@@ -45,7 +44,7 @@ class App {
   }
 
   private initializeMiddlewares() {
-    this.app.use(morgan(config.get('log.format'), { stream }));
+    this.app.use(morgan(LOG_FORMAT, { stream }));
     this.app.use(hpp());
     this.app.use(helmet());
     this.app.use(compression());
@@ -57,8 +56,8 @@ class App {
   private initializeRoutes(controllers: Function[]) {
     useExpressServer(this.app, {
       cors: {
-        origin: config.get('cors.origin'),
-        credentials: config.get('cors.credentials'),
+        origin: ORIGIN,
+        credentials: CREDENTIALS,
       },
       controllers: controllers,
       defaultErrorHandler: false,

package/lib/routing-controllers/src/config/index.ts

@@ -0,0 +1,5 @@
+import { config } from 'dotenv';
+config({ path: `.env.${process.env.NODE_ENV || 'development'}.local` });
+
+export const CREDENTIALS = process.env.CREDENTIALS === 'true';
+export const { NODE_ENV, PORT, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;

package/lib/routing-controllers/src/middlewares/auth.middleware.ts

@@ -1,6 +1,6 @@
-import config from 'config';
 import { NextFunction, Response } from 'express';
 import { verify } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
 import userModel from '@models/users.model';
@@ -10,7 +10,7 @@ const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFun
     const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
-      const secretKey: string = config.get('secretKey');
+      const secretKey: string = SECRET_KEY;
       const verificationResponse = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userId = verificationResponse.id;
       const findUser = userModel.find(user => user.id === userId);

package/lib/routing-controllers/src/server.ts

@@ -1,5 +1,3 @@
-import 'dotenv/config';
-import '@/index';
 import App from '@/app';
 import { AuthController } from '@controllers/auth.controller';
 import { IndexController } from '@controllers/index.controller';

package/lib/routing-controllers/src/services/auth.service.ts

@@ -1,6 +1,6 @@
 import { compare, hash } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
@@ -49,7 +49,7 @@ class AuthService {
 
   public createToken(user: User): TokenData {
     const dataStoredInToken: DataStoredInToken = { id: user.id };
-    const secretKey: string = config.get('secretKey');
+    const secretKey: string = SECRET_KEY;
     const expiresIn: number = 60 * 60;
 
     return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };

package/lib/routing-controllers/src/utils/logger.ts

@@ -1,11 +1,11 @@
-import config from 'config';
 import { existsSync, mkdirSync } from 'fs';
 import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
 
 // logs dir
-const logDir: string = join(__dirname, config.get('log.dir'));
+const logDir: string = join(__dirname, LOG_DIR);
 
 if (!existsSync(logDir)) {
   mkdirSync(logDir);

package/lib/routing-controllers/tsconfig.json

@@ -22,6 +22,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@dtos/*": ["dtos/*"],
       "@exceptions/*": ["exceptions/*"],

package/lib/sequelize/.env.development.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 3306
+DB_USER = root
+DB_PASSWORD = password
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/sequelize/.env.production.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 3306
+DB_USER = root
+DB_PASSWORD = password
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = combined
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = your.domain.com
+CREDENTIALS = true

package/lib/sequelize/.env.test.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 3306
+DB_USER = root
+DB_PASSWORD = password
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/sequelize/.swcrc

@@ -21,6 +21,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@databases": ["databases"],
       "@dtos/*": ["dtos/*"],

package/lib/sequelize/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/sequelize/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",
@@ -20,7 +20,6 @@
     "class-transformer": "^0.4.0",
     "class-validator": "^0.13.1",
     "compression": "^1.7.4",
-    "config": "^3.3.6",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
     "dotenv": "^10.0.0",
@@ -42,7 +41,6 @@
     "@swc/core": "^1.2.108",
     "@types/bcrypt": "^5.0.0",
     "@types/compression": "^1.7.1",
-    "@types/config": "^0.0.39",
     "@types/cookie-parser": "^1.4.2",
     "@types/cors": "^2.8.11",
     "@types/dotenv": "^8.2.0",

package/lib/sequelize/src/app.ts

@@ -1,14 +1,13 @@
-import '@/index';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
-import config from 'config';
 import express from 'express';
 import helmet from 'helmet';
 import hpp from 'hpp';
 import morgan from 'morgan';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
+import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
 import DB from '@databases';
 import { Routes } from '@interfaces/routes.interface';
 import errorMiddleware from '@middlewares/error.middleware';
@@ -16,13 +15,13 @@ import { logger, stream } from '@utils/logger';
 
 class App {
   public app: express.Application;
-  public port: string | number;
   public env: string;
+  public port: string | number;
 
   constructor(routes: Routes[]) {
     this.app = express();
-    this.port = process.env.PORT || 3000;
-    this.env = process.env.NODE_ENV || 'development';
+    this.env = NODE_ENV || 'development';
+    this.port = PORT || 3000;
 
     this.connectToDatabase();
     this.initializeMiddlewares();
@@ -49,8 +48,8 @@ class App {
   }
 
   private initializeMiddlewares() {
-    this.app.use(morgan(config.get('log.format'), { stream }));
-    this.app.use(cors({ origin: config.get('cors.origin'), credentials: config.get('cors.credentials') }));
+    this.app.use(morgan(LOG_FORMAT, { stream }));
+    this.app.use(cors({ origin: ORIGIN, credentials: CREDENTIALS }));
     this.app.use(hpp());
     this.app.use(helmet());
     this.app.use(compression());