typescript-express-starter 8.0.1 → 8.1.3

package/README.kr.md

@@ -107,6 +107,7 @@ $ npx typescript-express-starter "project name"
 | Knex                | 쿼리 빌더를 위한 라이브러리                                                                                                                                                     |
 | GraphQL             | API 용 쿼리 언어이며 기존 데이터로 이러한 쿼리를 수행하기위한 런타임                                                                                                            |
 | Typegoose           | 타입스크립트 클래스를 사용하여 몽구스 모델 정의                                                                                                                                 |
+| mikro-orm (개발중)  | 데이터 매퍼, 작업 단위 및 아이덴티티 맵 패턴을 기반으로 하는 Node.js용 TypeScript ORM. MongoDB, MySQL, MariaDB, PostgreSQL 및 SQLite 데이터베이스를 지원합니다.                 |
 
 ## 🛎 Script 명령어
 
@@ -370,6 +371,10 @@ VSCode Extension에서 [REST Client](https://marketplace.visualstudio.com/items?
 
 - WhatIfWeDigDeeper [https://github.com/WhatIfWeDigDeeper](https://github.com/WhatIfWeDigDeeper)
 
+- David Stewart [https://github.com/davidjmstewart](https://github.com/davidjmstewart)
+
+- JagTheFriend [JagTheFriend](https://github.com/JagTheFriend)
+
 ## 💳 라이센스
 
 [MIT](LICENSE)

package/README.md

@@ -100,17 +100,18 @@ Start your typescript-express-starter app in development mode at `http://localho
 
 #### Template Type
 
-| Name                | Description                                                                                                  |
-| :------------------ | :----------------------------------------------------------------------------------------------------------- |
-| Default             | Express Default                                                                                              |
-| Routing Controllers | Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage |
-| Sequelize           | Easy to use multi SQL dialect ORM for Node.js                                                                |
-| Mongoose            | MongoDB Object Modeling(ODM) designed to work in an asynchronous environment                                 |
-| TypeORM             | An ORM that can run in Node.js and Others                                                                    |
-| Prisma              | Modern Database Access for TypeScript & Node.js                                                              |
-| Knex                | SQL query builder for Postgres, MySQL, MariaDB, SQLite3 and Oracle                                           |
-| GraphQL             | query language for APIs and a runtime for fulfilling those queries with your existing data                   |
-| Typegoose           | Define Mongoose models using TypeScript classes                                                              |
+| Name                | Description                                                                                                                                                 |
+| :------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Default             | Express Default                                                                                                                                             |
+| Routing Controllers | Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage                                                |
+| Sequelize           | Easy to use multi SQL dialect ORM for Node.js                                                                                                               |
+| Mongoose            | MongoDB Object Modeling(ODM) designed to work in an asynchronous environment                                                                                |
+| TypeORM             | An ORM that can run in Node.js and Others                                                                                                                   |
+| Prisma              | Modern Database Access for TypeScript & Node.js                                                                                                             |
+| Knex                | SQL query builder for Postgres, MySQL, MariaDB, SQLite3 and Oracle                                                                                          |
+| GraphQL             | query language for APIs and a runtime for fulfilling those queries with your existing data                                                                  |
+| Typegoose           | Define Mongoose models using TypeScript classes                                                                                                             |
+| mikro-orm (Develop) | TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite databases. |
 
 ## 🛎 Available Commands for the Server
 
@@ -243,9 +244,7 @@ Modify `.swcrc` file to your source code.
 │
 ├── /src
 │   ├── /configs
-│   │   ├── development.json
-│   │   ├── production.json
-│   │   └── test.json
+│   │   ├── index.ts
 │   │
 │   ├── /controllers
 │   │   ├── auth.controller.ts
@@ -300,7 +299,9 @@ Modify `.swcrc` file to your source code.
 │
 ├── .dockerignore
 ├── .editorconfig
-├── .env
+├── .env.development.local
+├── .env.production.local
+├── .env.test.local
 ├── .eslintignore
 ├── .eslintrc
 ├── .gitignore
@@ -375,6 +376,10 @@ Modify `.swcrc` file to your source code.
 
 - WhatIfWeDigDeeper [https://github.com/WhatIfWeDigDeeper](https://github.com/WhatIfWeDigDeeper)
 
+- David Stewart [https://github.com/davidjmstewart](https://github.com/davidjmstewart)
+
+- JagTheFriend [JagTheFriend](https://github.com/JagTheFriend)
+
 ## 💳 License
 
 [MIT](LICENSE)

package/lib/default/.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/default/.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/default/.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/default/.swcrc

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

package/lib/default/package.json

@@ -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",
@@ -40,7 +39,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/default/src/app.ts

@@ -1,27 +1,26 @@
-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 { 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/default/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/default/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/default/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/default/src/services/auth.service.ts

@@ -1,6 +1,6 @@
 import { hash, compare } 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/default/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/default/tsconfig.json

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

package/lib/graphql/.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/graphql/.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/graphql/.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/graphql/.swcrc

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

package/lib/graphql/package.json

@@ -21,7 +21,6 @@
     "bcrypt": "^5.0.1",
     "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",
@@ -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/graphql/src/app.ts

@@ -1,16 +1,15 @@
 import 'reflect-metadata';
-import '@/index';
 import { ApolloServerPluginLandingPageProductionDefault, ApolloServerPluginLandingPageLocalDefault } from 'apollo-server-core';
 import { ApolloServer } from 'apollo-server-express';
 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 { buildSchema } from 'type-graphql';
 import { createConnection } from 'typeorm';
+import { NODE_ENV, PORT, ORIGIN, CREDENTIALS } from '@config';
 import { dbConnection } from '@databases';
 import { authMiddleware, authChecker } from '@middlewares/auth.middleware';
 import errorMiddleware from '@middlewares/error.middleware';
@@ -18,13 +17,13 @@ import { logger, responseLogger, errorLogger } from '@utils/logger';
 
 class App {
   public app: express.Application;
-  public port: string | number;
   public env: string;
+  public port: string | number;
 
   constructor(resolvers) {
     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();
@@ -51,7 +50,7 @@ class App {
   }
 
   private initializeMiddlewares() {
-    this.app.use(cors({ origin: config.get('cors.origin'), credentials: config.get('cors.credentials') }));
+    this.app.use(cors({ origin: ORIGIN, credentials: CREDENTIALS }));
     this.app.use(hpp());
     this.app.use(helmet());
     this.app.use(compression());
@@ -69,7 +68,7 @@ class App {
     const apolloServer = new ApolloServer({
       schema: schema,
       plugins: [
-        process.env.NODE_ENV === 'production'
+        NODE_ENV === 'production'
           ? ApolloServerPluginLandingPageProductionDefault({ footer: false })
           : ApolloServerPluginLandingPageLocalDefault({ footer: false }),
       ],
@@ -94,7 +93,7 @@ class App {
     });
 
     await apolloServer.start();
-    apolloServer.applyMiddleware({ app: this.app, cors: true, path: '/graphql' });
+    apolloServer.applyMiddleware({ app: this.app, cors: ORIGIN, path: '/graphql' });
   }
 
   private initializeErrorHandling() {

package/lib/graphql/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, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;

package/lib/graphql/src/databases/index.ts

@@ -1,16 +1,14 @@
-import config from 'config';
 import { join } from 'path';
 import { ConnectionOptions } from 'typeorm';
-import { dbConfig } from '@interfaces/db.interface';
+import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from '@config';
 
-const { host, port, user, password, database }: dbConfig = config.get('dbConfig');
 export const dbConnection: ConnectionOptions = {
   type: 'postgres',
-  host: host,
-  port: port,
-  username: user,
-  password: password,
-  database: database,
+  host: DB_HOST,
+  port: DB_PORT,
+  username: DB_USER,
+  password: DB_PASSWORD,
+  database: DB_DATABASE,
   synchronize: true,
   logging: false,
   entities: [join(__dirname, '../**/*.entity{.ts,.js}')],

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

@@ -1,7 +1,7 @@
-import config from 'config';
 import { verify } from 'jsonwebtoken';
 import { AuthChecker } from 'type-graphql';
 import { getRepository } from 'typeorm';
+import { SECRET_KEY } from '@config';
 import { UserEntity } from '@entities/users.entity';
 import { HttpException } from '@exceptions/HttpException';
 import { RequestWithUser, DataStoredInToken } from '@interfaces/auth.interface';
@@ -10,7 +10,7 @@ export const authMiddleware = async req => {
   try {
     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 { id } = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userRepository = getRepository(UserEntity);
       const findUser = await userRepository.findOne(id, { select: ['id', 'email', 'password'] });

package/lib/graphql/src/repositories/auth.repository.ts

@@ -1,7 +1,7 @@
 import { hash, compare } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
 import { EntityRepository } from 'typeorm';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { UserEntity } from '@entities/users.entity';
 import { HttpException } from '@exceptions/HttpException';
@@ -49,7 +49,7 @@ export default class AuthRepository {
 
   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/graphql/src/server.ts

@@ -1,6 +1,3 @@
-import 'reflect-metadata';
-import 'dotenv/config';
-import '@/index';
 import App from '@/app';
 import validateEnv from '@utils/validateEnv';
 

package/lib/graphql/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/graphql/tsconfig.json

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

package/lib/knex/.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/knex/.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/knex/.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/knex/.swcrc

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

package/lib/knex/knexfile.ts

@@ -1,19 +1,15 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/src/configs';
+import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from './src/config';
 
-import config from 'config';
-import { dbConfig } from './src/interfaces/db.interface';
-
-const { host, user, password, database, port }: dbConfig = config.get('dbConfig');
 export = {
   client: 'mysql',
   connection: {
     charset: 'utf8',
     timezone: 'UTC',
-    host: host,
-    user: user,
-    password: password,
-    database: database,
-    port: port,
+    host: DB_HOST,
+    port: DB_PORT,
+    user: DB_USER,
+    password: DB_PASSWORD,
+    database: DB_DATABASE
   },
   migrations: {
     directory: 'src/databases/migrations',

package/lib/knex/package.json

@@ -25,7 +25,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": "^9.0.2",
@@ -48,7 +47,6 @@
     "@swc/core": "^1.2.108",
     "@types/bcrypt": "^5.0.0",
     "@types/compression": "^1.7.0",
-    "@types/config": "0.0.38",
     "@types/cookie-parser": "^1.4.2",
     "@types/cors": "^2.8.10",
     "@types/dotenv": "^8.2.0",