Main Release - 202409

.dockerignore

@@ -2,3 +2,4 @@
 *Dockerfile*
 node_modules
 dist
+volumes

.github/workflows/cd-dev.yml

@@ -0,0 +1,27 @@
+name: dev branch auto ci process script
+
+on: # 아래 job을 실행시킬 상황
+  push:
+    branches: [dev]
+
+jobs:
+  deploy:
+    name: deploy
+    runs-on: ubuntu-latest # 실행될 인스턴스 OS와 버전
+
+    steps:
+      - name: excuting remote ssh commands
+        uses: appleboy/ssh-action@v0.1.6 # ssh 접속하는 오픈소스
+        with:
+          host: ${{ secrets.REMOTE_IP_DEV }} # 인스턴스 IP
+          username: ${{ secrets.REMOTE_USER_DEV }} # 우분투 아이디
+          key: ${{ secrets.REMOTE_PRIVATE_KEY_DEV }} # ec2 instance pem key
+          port: ${{ secrets.REMOTE_SSH_PORT_DEV }} # 접속포트
+          passphrase: ${{ secrets.REMOTE_PASSPHRASE_DEV }}
+          script: | # 실행할 스크립트
+            cd otlplus-nest-server
+            git pull origin dev
+            sudo docker stop otlplus-server-nest-dev
+            sudo docker rm otlplus-server-nest-dev
+            sudo docker rmi otlplus-server-nest-dev
+            sudo ./deploy.sh -e dev

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [main]
+    branches: [main, dev, release]
   pull_request:
-    branches: [main]
+    branches: [main, dev, release]
 
 env:
   NODE_VERSION: 18
@@ -23,7 +23,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
           cache: 'npm'
       - name: Install dependencies
-        run: npm ci
+        run: npm ci --force
       - name: Check format
         run: npm run format:check
 
@@ -40,7 +40,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
           cache: 'npm'
       - name: Install dependencies
-        run: npm ci
+        run: npm ci --force
       - name: Check lint
         run: npm run lint:check
 
@@ -57,8 +57,10 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
           cache: 'npm'
       - name: Install dependencies
-        run: npm ci
+        run: npm ci --force
       - name: Copy env file
         run: cp ./env/.env.example ./env/.env.local
+      - name: Generate PrismaClient
+        run: npm run client:generate
       - name: Build
         run: npm run build

.github/workflows/code-review.yml

@@ -0,0 +1,28 @@
+name: Code Review
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  gpt-review:
+    if: ${{ contains(github.event.*.labels.*.name, 'gpt review') }} # Optional; to run only when a label is attached
+    runs-on: ubuntu-latest
+    steps:
+      - uses: anc95/ChatGPT-CodeReview@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          # Optional
+          LANGUAGE: Korean
+          OPENAI_API_ENDPOINT: https://api.openai.com/v1
+          MODEL: gpt-4o-mini # https://platform.openai.com/docs/models
+          PROMPT: # example: Please check if there are any confusions or irregularities in the following code diff:
+          top_p: 1 # https://platform.openai.com/docs/api-reference/chat/create#chat/create-top_p
+          temperature: 1 # https://platform.openai.com/docs/api-reference/chat/create#chat/create-temperature
+          max_tokens: 10000
+          MAX_PATCH_LENGTH: 10000 # if the patch/diff length is large than MAX_PATCH_LENGTH, will be ignored and won't review. By default, with no MAX_PATCH_LENGTH set, there is also no limit for the patch/diff length.

.nvmrc

@@ -0,0 +1 @@
+v18.17.0

.prettierrc

@@ -1,4 +1,4 @@
 {
   "singleQuote": true,
   "trailingComma": "all"
-}
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "explicit"
+  }
+}

README.md

@@ -1,6 +1,6 @@
 # OTL Plus Server
 
-[![CI](https://github.com/sparcs-kaist/otlplus-server/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sparcs-kaist/otlplus-server/actions/workflows/ci.yml)
+[![CI](https://github.com/sparcs-kaist/otlplus-server/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/sparcs-kaist/otlplus-server/actions/workflows/ci.yml)
 
 ## How to run
 
@@ -26,6 +26,30 @@ sudo docker compose up
 
 또는 로컬에서 MySQL 5.7을 설치하여 연결할 수 있습니다.
 
+### Node.js 설치 및 버전 관리
+
+Node.js v18 을 설치합니다.
+
+버전 체크
+
+```bash
+node -v # v18.17.0
+npm -v  # v9.x.x
+```
+
+(Tip) [nvm](https://github.com/nvm-sh/nvm) 설치 후, nvm을 이용하여 로컬 개발 환경의 node.js 버전을 설정하는 것을 권장합니다!
+
+```bash
+nvm install 18
+nvm use 18
+```
+
+아래 명령어를 사용하면 `.nvmrc` 설정 파일에 따라 자동으로 버전이 변경됩니다.
+
+```bash
+nvm use # uses v18
+```
+
 ### NestJS 서버 실행
 
 ```sh

deploy.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+usage() {
+  echo "Usage: $0 -e value"
+  echo "  -e: 현재 배포 환경을 입력하세요. (prod, dev, local)"
+}
+
+NODE_ENV=""
+
+while getopts "e:" opt; do
+  case $opt in
+    e)
+      NODE_ENV=$OPTARG
+      echo "NODE_ENV: $NODE_ENV"
+      if [[ "$NODE_ENV" = "prod" ]]; then
+         COMPOSE_FILE="docker/docker-compose.prod.yml"
+      elif [[ "$NODE_ENV" = "dev" ]]; then
+          COMPOSE_FILE="docker/docker-compose.dev.yml"
+      elif [[ "$NODE_ENV" = "local" ]]; then
+          COMPOSE_FILE="docker/docker-compose.local.yml"
+      else
+        echo "Invalid environment: $NODE_ENV" 1>&2
+        usage
+        exit 1
+      fi
+
+      if [[ ! -f "$COMPOSE_FILE" ]]; then
+        echo "Error: Compose file does not exist: $COMPOSE_FILE" 1>&2
+        exit 1
+      fi
+
+      docker-compose -f "$COMPOSE_FILE" up -d
+      ;;
+    \?)
+      echo "Invalid option: -$OPTARG" 1>&2
+      usage
+      exit 1
+      ;;
+  esac
+done
+
+if [ -z "$NODE_ENV" ]; then
+  echo "Error: Environment option is required."
+  usage
+  exit 1
+fi

docker/Dockerfile.server

@@ -1,6 +1,4 @@
-FROM node:18
-
-ENV NODE_ENV=dev
+FROM node:18 AS build
 
 RUN mkdir -p /var/www/otlplus-server
 WORKDIR /var/www/otlplus-server
@@ -9,8 +7,16 @@ COPY package*.json ./
 RUN npm install
 
 COPY . .
-RUN npm run prisma-generate
+RUN npm run client:generate
 RUN npm run build
 
-EXPOSE 3000
-CMD [ "npm", "run", "start:dev" ]
+FROM node:18-slim AS server
+RUN apt-get update -y && apt-get install -y openssl
+
+COPY --from=build /var/www/otlplus-server/ /var/www/otlplus-server/
+
+WORKDIR /var/www/otlplus-server
+
+RUN npm prune --production
+
+EXPOSE 8000

docker-compose.yml → docker/docker-compose-db-local.yml

@@ -3,12 +3,12 @@ version: '3.4'
 services:
   db:
     container_name: otlplus-server-db
-    image: mysql:5.7
+    image: mysql:8.0.36
     restart: on-failure
     ports:
       - '${OTLPLUS_DB_PORT:-43306}:3306'
     environment:
-      - MYSQL_ROOT_HOSTS=%
+      - MYSQL_ROOT_HOSTS=admin
       - MYSQL_ROOT_PASSWORD=${OTLPLUS_DB_PASSWORD:-password}
       - MYSQL_DATABASE=otlplus
       - TZ=Asia/Seoul

docker/docker-compose.dev.yml

@@ -1,36 +1,23 @@
 version: '3.4'
 
 services:
-  db:
-    container_name: otlplus-server-db
-    platform: linux/amd64
-    image: mysql:5.7
-    restart: on-failure
-    ports:
-      - "43306:3306"
-    environment:
-      - MYSQL_ROOT_HOSTS=%
-      - MYSQL_ROOT_PASSWORD=${OTLPLUS_DB_PASSWORD:-password}
-      - MYSQL_DATABASE=otlplus
-      - TZ=Asia/Seoul
-    volumes:
-      - ../volumes/db:/var/lib/mysql
-      - ../volumes/dump:/dump
-    command: |
-      --sql_mode=NO_ENGINE_SUBSTITUTION --default_storage_engine=InnoDB 
-      --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
   back:
-    depends_on:
-      - db
-    container_name: otlplus-server
+    container_name: otlplus-server-nest-dev
     platform: linux/amd64
+    env_file:
+      - ../env/.env.dev
+    environment:
+      - NODE_ENV=dev
+      - DOCKER_DEPLOY=true
     build:
       context: ..
       dockerfile: ./docker/Dockerfile.server
+    image: otlplus-server-nest-dev
     restart: always
     tty: true
     ports:
-      - "43000:3000"
+      - '8080:8000'
     volumes:
-      - "/etc/timezone:/etc/timezone:ro"
+      - '/etc/timezone:/etc/timezone:ro'
     working_dir: /var/www/otlplus-server
+    command: node dist/src/bootstrap/bootstrap.js

docker/docker-compose.local.yml

@@ -0,0 +1,26 @@
+version: '3.4'
+
+services:
+  back:
+    container_name: otlplus-server-nest-local
+    platform: linux/amd64
+    env_file:
+      - ../env/.env.local
+    environment:
+      - NODE_ENV=local
+      - DOCKER_DEPLOY=true
+    build:
+      context: ..
+      dockerfile: ./docker/Dockerfile.server
+    image: otlplus-server-nest-local
+    restart: always
+    tty: true
+    ports:
+      - '58000:8000'
+    expose:
+      - '8000'
+    volumes:
+      - '/etc/timezone:/etc/timezone:ro'
+    network_mode: 'host'
+    working_dir: /var/www/otlplus-server
+    command: node dist/src/bootstrap/bootstrap.js

docker/docker-compose.prod.yml

@@ -0,0 +1,23 @@
+version: '3.4'
+
+services:
+  back:
+    container_name: otlplus-server-nest-prod
+    platform: linux/amd64
+    env_file:
+      - ../env/.env.prod
+    environment:
+      - NODE_ENV=prod
+      - DOCKER_DEPLOY=true
+    build:
+      context: ..
+      dockerfile: ./docker/Dockerfile.server
+    image: otlplus-server-nest-prod
+    restart: always
+    tty: true
+    ports:
+      - '58000:8000'
+    volumes:
+      - '/etc/timezone:/etc/timezone:ro'
+    working_dir: /var/www/otlplus-server
+    command: node dist/src/bootstrap/bootstrap.js