typescript-express-starter 6.3.0 → 7.0.0

package/README.kr.md

@@ -100,12 +100,12 @@ $ npx typescript-express-starter "project name"
 | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | Default             | Express 기본                                                                                                                                                                    |
 | Routing Controllers | 데코레이터 사용량이 많은 구조화되고 선언적이며 아름답게 구성된 클래스 기반 컨트롤러 생성                                                                                        |
-| Sequlize            | Postgres, MySQL, MariaDB, SQLite, Microsoft SQL Server를 지원하는 Promise 패턴 기반의 Node.js ORM                                                                               |
+| Sequelize           | Postgres, MySQL, MariaDB, SQLite, Microsoft SQL Server를 지원하는 Promise 패턴 기반의 Node.js ORM                                                                               |
 | Mongoose            | Node.js와 MongoDB를 위한 ODM(Object Data Mapping) 라이브러리                                                                                                                    |
 | TypeORM             | 자바스크립트, 타입스크립트과 함께 사용되어 Node.js, React Native, Expo에서 실행될 수 있는 ORM                                                                                   |
 | Prisma              | 데이터베이스에 데이터를 프로그래밍 언어의 객체와 매핑하여 기존에 SQL로 작성하던 데이터를 수정, 테이블 구조 변경등의 작업을 객체를 통해 프로그래밍적으로 할 수 있도록 해주는 ORM |
 | Knex                | 쿼리 빌더를 위한 라이브러리                                                                                                                                                     |
-| GraphQL (개발중)    | API 용 쿼리 언어이며 기존 데이터로 이러한 쿼리를 수행하기위한 런타임                                                                                                            |
+| GraphQL             | API 용 쿼리 언어이며 기존 데이터로 이러한 쿼리를 수행하기위한 런타임                                                                                                            |
 
 ## 🛎 Script 명령어
 
@@ -145,24 +145,24 @@ $ npx typescript-express-starter "project name"
 
 > [Simple Icons](https://simpleicons.org/)
 
-### 🐳 도커 :: 컨테이너 플랫폼
+### 🐳 Docker :: 컨테이너 플랫폼
 
-[도커](https://docs.docker.com/)란, 컨테이너 기반의 오픈소스 가상화 플랫폼이다.
+[Docker](https://docs.docker.com/)란, 컨테이너 기반의 오픈소스 가상화 플랫폼이다.
 
-[도커 설치 홈페이지](https://docs.docker.com/get-docker/)에 접속해서 설치를 해줍니다.
+[설치 홈페이지](https://docs.docker.com/get-docker/)에 접속해서 설치를 해줍니다.
 
 - 백그라운드에서 컨테이너를 시작하고 실행 : `docker-compose up -d`
 - 컨테이너를 중지하고 컨테이너, 네트워크, 볼륨 및 이미지를 제거 : `docker-compose down`
 
 수정을 원하시면 `docker-compose.yml`과 `Dockerfile`를 수정해주시면 됩니다.
 
-### ♻️ 엔진엑스 :: 웹 서버
+### ♻️ Nginx :: 웹 서버
 
-[엔진엑스](https://www.nginx.com/) 역방향 프록시,로드 밸런서, 메일 프록시 및 HTTP 캐시로도 사용할 수있는 웹 서버입니다.
+[Nginx](https://www.nginx.com/) 역방향 프록시,로드 밸런서, 메일 프록시 및 HTTP 캐시로도 사용할 수있는 웹 서버입니다.
 
 프록시는 일반적으로 여러 서버에로드를 분산하거나, 다른 웹 사이트의 콘텐츠를 원활하게 표시하거나, HTTP 이외의 프로토콜을 통해 처리 요청을 애플리케이션 서버에 전달하는 데 사용됩니다.
 
-엔진엑스가 요청을 프록시하면 지정된 프록시 서버로 요청을 보내고 응답을 가져 와서 클라이언트로 다시 보냅니다.
+Nginx 요청을 프록시하면 지정된 프록시 서버로 요청을 보내고 응답을 가져 와서 클라이언트로 다시 보냅니다.
 
 수정을 원하시면 `nginx.conf` 파일을 수정해주시면 됩니다.
 
@@ -188,13 +188,13 @@ $ npx typescript-express-starter "project name"
 
 > 2019년, TSLint 지원이 종료 되어 ESLint를 적용하였습니다.
 
-### 📗 스웨거 :: API 문서화
+### 📗 Swagger :: API 문서화
 
-[스웨거](https://swagger.io/)는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다.
+[Swagger](https://swagger.io/)는 개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다.
 
 API를 대규모로 설계하고 문서화하는 데 용이하게 사용합니다.
 
-스웨거 URL은 `http://localhost:3000/api-docs` 으로 작성했습니다.
+Swagger URL은 `http://localhost:3000/api-docs` 으로 작성했습니다.
 
 수정을 원하시면 `swagger.yaml` 파일을 수정해주시면 됩니다.
 
@@ -364,6 +364,8 @@ VSCode Extension에서 [REST Client](https://marketplace.visualstudio.com/items?
 
 - oricc [https://github.com/oricc](https://github.com/oricc)
 
+- Dustin Newbold [https://github.com/dustinnewbold](https://github.com/dustinnewbold)
+
 ## 💳 라이센스
 
 [MIT](LICENSE)

package/README.md

@@ -100,16 +100,16 @@ Start your typescript-express-starter app in development mode at `http://localho
 
 #### Template Type
 
-| Name                 | Desc                                                                                                         |
-| :------------------- | :----------------------------------------------------------------------------------------------------------- |
-| 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 (Developing) | query language for APIs and a runtime for fulfilling those queries with your existing data                   |
+| Name                | Desc                                                                                                         |
+| :------------------ | :----------------------------------------------------------------------------------------------------------- |
+| 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                   |
 
 ## 🛎 Available Commands for the Server
 
@@ -369,6 +369,8 @@ Modify `.swcrc` file to your source code.
 
 - oricc [https://github.com/oricc](https://github.com/oricc)
 
+- Dustin Newbold [https://github.com/dustinnewbold](https://github.com/dustinnewbold)
+
 ## 💳 License
 
 [MIT](LICENSE)

package/lib/graphql/.dockerignore

@@ -0,0 +1,18 @@
+# compiled output
+.vscode
+/node_modules
+
+# code formatter
+.eslintrc
+.eslintignore
+.editorconfig
+.huskyrc
+.lintstagedrc.json
+.prettierrc
+
+# test
+jest.config.js
+
+# docker
+Dockerfile
+docker-compose.yml

package/lib/graphql/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/lib/graphql/.env

@@ -0,0 +1 @@
+PORT=3000

package/lib/graphql/.eslintignore

@@ -0,0 +1 @@
+/dist

package/lib/graphql/.eslintrc

@@ -0,0 +1,18 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": ["prettier", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "rules": {
+    "@typescript-eslint/explicit-member-accessibility": 0,
+    "@typescript-eslint/explicit-function-return-type": 0,
+    "@typescript-eslint/no-parameter-properties": 0,
+    "@typescript-eslint/interface-name-prefix": 0,
+    "@typescript-eslint/explicit-module-boundary-types": 0,
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-var-requires": "off"
+  }
+}

package/lib/graphql/.huskyrc

@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "lint-staged"
+  }
+}

package/lib/graphql/.lintstagedrc.json

@@ -0,0 +1,5 @@
+{
+  "*.ts": [
+    "npm run lint"
+  ]
+}

package/lib/graphql/.prettierrc

@@ -0,0 +1,8 @@
+{
+    "printWidth": 150,
+    "tabWidth": 2,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "semi": true,
+    "arrowParens": "avoid"
+}

package/lib/graphql/.swcrc

@@ -0,0 +1,39 @@
+{
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "tsx": false,
+      "dynamicImport": true,
+      "decorators": true
+    },
+    "transform": {
+      "legacyDecorator": true,
+      "decoratorMetadata": true
+    },
+    "target": "es2017",
+    "externalHelpers": false,
+    "keepClassNames": true,
+    "loose": false,
+    "minify": {
+      "compress": false,
+      "mangle": false
+    },
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@entities/*": ["entities/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@repositories/*": ["repositories/*"],
+      "@resolvers/*": ["resolvers/*"],
+      "@typedefs/*": ["typedefs/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "module": {
+    "type": "commonjs"
+  }
+}

package/lib/graphql/.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Dev typescript-express-starter",
+            "command": "npm run dev"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Start typescript-express-starter",
+            "command": "npm run start"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Test typescript-express-starter",
+            "command": "npm run test"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Lint typescript-express-starter",
+            "command": "npm run lint"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Lint:Fix typescript-express-starter",
+            "command": "npm run lint:fix"
+        }
+    ]
+}

package/lib/graphql/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "editor.formatOnSave": false
+}

package/lib/graphql/Dockerfile

@@ -0,0 +1,24 @@
+# Common build stage
+FROM node:14.14.0-alpine3.12 as common-build-stage
+
+COPY . ./app
+
+WORKDIR /app
+
+RUN npm install
+
+EXPOSE 3000
+
+# Development build stage
+FROM common-build-stage as development-build-stage
+
+ENV NODE_ENV development
+
+CMD ["npm", "run", "dev"]
+
+# Production build stage
+FROM common-build-stage as production-build-stage
+
+ENV NODE_ENV production
+
+CMD ["npm", "run", "start"]

package/lib/graphql/Makefile

@@ -0,0 +1,6 @@
+build:
+	docker build -t ${tag} .
+clean:
+	docker rmi -f ${tag}
+run:
+	docker run -d -p ${port}:${port} --name ${name} ${tag}

package/lib/graphql/docker-compose.yml

@@ -0,0 +1,50 @@
+version: '3.7'
+
+services:
+  proxy:
+    image: nginx:alpine
+    container_name: proxy
+    ports:
+      - '80:80'
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+    restart: 'unless-stopped'
+    networks:
+      - backend
+  server:
+    build:
+      context: ./
+      target: development-build-stage
+      dockerfile: Dockerfile
+    container_name: server
+    ports:
+      - '3000:3000'
+    volumes:
+      - ./:/app
+      - /app/node_modules
+    restart: 'unless-stopped'
+    networks:
+      - backend
+    links:
+      - pg
+    depends_on:
+      - pg
+  pg:
+    image: bitnami/postgresql:11-debian-9
+    container_name: pg
+    environment:
+      POSTGRESQL_USERNAME: root
+      POSTGRESQL_PASSWORD: password
+      POSTGRESQL_DATABASE: test
+    ports:
+      - '5432:5432'
+    networks:
+      - backend
+
+networks:
+  backend:
+    driver: bridge
+
+volumes:
+  data:
+    driver: local

package/lib/graphql/ecosystem.config.js

@@ -0,0 +1,59 @@
+/**
+ * @description pm2 configuration file.
+ * @example
+ *  production mode :: pm2 start ecosystem.config.js --only prod
+ *  development mode :: pm2 start ecosystem.config.js --only dev
+ */
+ module.exports = {
+  apps: [
+    {
+      name: 'prod', // pm2 start App name
+      script: 'dist/server.js',
+      exec_mode: 'cluster', // 'cluster' or 'fork'
+      instance_var: 'INSTANCE_ID', // instance variable
+      instances: 2, // pm2 instance count
+      autorestart: true, // auto restart if process crash
+      watch: false, // files change automatic restart
+      ignore_watch: ['node_modules', 'logs'], // ignore files change
+      max_memory_restart: '1G', // restart if process use more than 1G memory
+      merge_logs: true, // if true, stdout and stderr will be merged and sent to pm2 log
+      output: './logs/access.log', // pm2 log file
+      error: './logs/error.log', // pm2 error log file
+      env: {
+        // environment variable
+        PORT: 3000,
+        NODE_ENV: 'production',
+      },
+    },
+    {
+      name: 'dev', // pm2 start App name
+      script: 'ts-node', // ts-node
+      args: '-r tsconfig-paths/register --transpile-only src/server.ts', // ts-node args
+      exec_mode: 'cluster', // 'cluster' or 'fork'
+      instance_var: 'INSTANCE_ID', // instance variable
+      instances: 2, // pm2 instance count
+      autorestart: true, // auto restart if process crash
+      watch: false, // files change automatic restart
+      ignore_watch: ['node_modules', 'logs'], // ignore files change
+      max_memory_restart: '1G', // restart if process use more than 1G memory
+      merge_logs: true, // if true, stdout and stderr will be merged and sent to pm2 log
+      output: './logs/access.log', // pm2 log file
+      error: './logs/error.log', // pm2 error log file
+      env: {
+        // environment variable
+        PORT: 3000,
+        NODE_ENV: 'development',
+      },
+    },
+  ],
+  deploy: {
+    production: {
+      user: 'user',
+      host: '0.0.0.0',
+      ref: 'origin/master',
+      repo: 'git@github.com:repo.git',
+      path: 'dist/server.js',
+      'post-deploy': 'npm install && npm run build && pm2 reload ecosystem.config.js --only prod',
+    },
+  },
+};

package/lib/graphql/jest.config.js

@@ -0,0 +1,12 @@
+const { pathsToModuleNameMapper } = require('ts-jest/utils');
+const { compilerOptions } = require('./tsconfig.json');
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/src' }),
+};

package/lib/graphql/nginx.conf

@@ -0,0 +1,40 @@
+user  nginx;
+worker_processes  1;
+
+error_log  /var/log/nginx/error.log warn;
+pid        /var/run/nginx.pid;
+
+events {
+    worker_connections  1024;
+}
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    upstream api-server {
+        server server:3000;
+        keepalive 100;
+    }
+
+    server {
+        listen 80;
+        server_name localhost;
+
+        location / {
+		proxy_http_version 1.1;
+            	proxy_pass         http://api-server;
+        }
+
+    }
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log  /var/log/nginx/access.log  main;
+
+    sendfile        on;
+    keepalive_timeout  65;
+    include /etc/nginx/conf.d/*.conf;
+}

package/lib/graphql/nodemon.json

@@ -0,0 +1,12 @@
+{
+    "watch": [
+        "src",
+        ".env"
+    ],
+    "ext": "js,ts,json",
+    "ignore": [
+        "src/logs/*",
+        "src/**/*.{spec,test}.ts"
+    ],
+    "exec": "ts-node -r tsconfig-paths/register --transpile-only src/server.ts"
+}

package/lib/graphql/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "graphql",
+  "version": "0.0.0",
+  "description": "TypeScript + GraphQL + TypeORM + Express API Server",
+  "author": "",
+  "license": "ISC",
+  "scripts": {
+    "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
+    "dev": "cross-env NODE_ENV=development nodemon",
+    "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",
+    "deploy:prod": "npm run build && pm2 start ecosystem.config.js --only prod",
+    "deploy:dev": "pm2 start ecosystem.config.js --only dev"
+  },
+  "dependencies": {
+    "apollo-server-core": "^3.5.0",
+    "apollo-server-express": "^3.5.0",
+    "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",
+    "envalid": "^7.1.0",
+    "express": "^4.17.1",
+    "graphql": "^15.8.0",
+    "helmet": "^4.6.0",
+    "hpp": "^0.2.3",
+    "jsonwebtoken": "^8.5.1",
+    "pg": "^8.7.1",
+    "reflect-metadata": "^0.1.13",
+    "type-graphql": "^1.1.1",
+    "typeorm": "^0.2.34",
+    "winston": "^3.3.3",
+    "winston-daily-rotate-file": "^4.5.5"
+  },
+  "devDependencies": {
+    "@swc/cli": "^0.1.51",
+    "@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",
+    "@types/express": "^4.17.13",
+    "@types/helmet": "^4.0.0",
+    "@types/hpp": "^0.2.1",
+    "@types/jest": "^26.0.24",
+    "@types/jsonwebtoken": "^8.5.4",
+    "@types/node": "^16.0.1",
+    "@types/supertest": "^2.0.11",
+    "@types/winston": "^2.4.4",
+    "@typescript-eslint/eslint-plugin": "^4.28.2",
+    "@typescript-eslint/parser": "^4.28.2",
+    "cross-env": "^7.0.3",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "husky": "^7.0.1",
+    "jest": "^27.0.6",
+    "lint-staged": "^11.0.0",
+    "node-config": "^0.0.2",
+    "node-gyp": "^8.1.0",
+    "nodemon": "^2.0.9",
+    "pm2": "^5.1.0",
+    "prettier": "^2.3.2",
+    "supertest": "^6.1.3",
+    "ts-jest": "^27.0.7",
+    "ts-node": "^10.4.0",
+    "tsc-alias": "^1.4.1",
+    "tsconfig-paths": "^3.10.1",
+    "typescript": "^4.5.2"
+  }
+}