diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..0cf2296
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,13 @@
+# --- 개행 문자 규칙 ---
+# 모든 텍스트 파일은 LF로 통일
+# checkstyle 규칙 적용을 위한 설정 (window 개행 문자 문제)
+* text=auto eol=lf
+
+# --- 예외 규칙 ---
+# Windows 환경에서만 CRLF가 꼭 필요한 경우 (.bat 파일)
+*.bat text eol=crlf
+
+# --- 파일 종류 ---
+# 이미지/바이너리 파일은 변환 금지
+*.png binary
+*.jar binary
\ No newline at end of file
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..f7faf04
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,35 @@
+## 🔑 JIRA 이슈 키
+
+
+
+---
+
+## ✒ 진행한 작업
+
+- [x] 진행한 작업
+- [x] 진행한 작업
+- [x] 진행한 작업
+
+---
+
+## 💡 생겼던 문제 및 해결법
+
+1️⃣ 요약
+
+- 문제:
+- 해결:
+
+---
+
+## 📢 아쉬운 부분 및 개선점
+
+- ...
+
+---
+
+## 📚 개발에 참고한 자료 및 포인트
+
+- 참고한 부분 요약 및 포인트
+ - link
+
+---
diff --git a/.github/workflows/cd-pipeline.yml b/.github/workflows/cd-pipeline.yml
new file mode 100644
index 0000000..2378d74
--- /dev/null
+++ b/.github/workflows/cd-pipeline.yml
@@ -0,0 +1,59 @@
+name: Java CD with Gradle
+
+on:
+ push:
+ branches:
+ - main
+ - feature/KOBG-4/initial-setting
+
+permissions:
+ contents: read
+
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: 🔄 체크아웃 코드
+ uses: actions/checkout@v4
+
+ - name: ☕ JDK 17 설치
+ uses: actions/setup-java@v4
+ with:
+ java-version: 17
+ distribution: 'corretto'
+
+ - name: 📝 application.yml 생성
+ run: |
+ cd ./src/main/resources
+ touch ./application.yml
+ echo "${{ secrets.PROPERTIES }}" > ./application.yml
+ shell: bash
+
+ - name: 🔧 빌드 권한 부여
+ run: chmod +x gradlew
+
+ - name: 🏗️ 프로젝트 jar 파일 제작
+ run: |
+ chmod +x gradlew
+ ./gradlew bootJar
+
+ - name: 🐳 Docker 로그인
+ run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+
+ - name: 🏗️ Docker 이미지 빌드 및 푸시
+ run: |
+ docker build -t ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }} .
+ docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }}
+
+ - name: 🚀 EC2에 프로젝트 전송 및 배포
+ uses: appleboy/ssh-action@master
+ with:
+ host: ${{ secrets.HOST }}
+ username: ${{ secrets.USERNAME }}
+ key: ${{ secrets.KEY }}
+ script: |
+ cd /home/ubuntu/app
+ export IMAGE_TAG=${{ github.sha }} sudo docker compose up -d --pull always
+ sudo docker ps
+ sudo docker image prune -f
diff --git a/.github/workflows/ci-pipeline.yml b/.github/workflows/ci-pipeline.yml
new file mode 100644
index 0000000..17405f8
--- /dev/null
+++ b/.github/workflows/ci-pipeline.yml
@@ -0,0 +1,61 @@
+name: Java CI with Gradle
+
+on:
+ pull_request:
+ branches:
+ - main
+ - develop
+
+permissions:
+ contents: read
+ checks: write
+ pull-requests: write
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: 🔄 체크아웃
+ uses: actions/checkout@v4
+
+ - name: ☕ JDK 17 설치
+ uses: actions/setup-java@v4
+ with:
+ java-version: 17
+ distribution: 'corretto'
+
+ - name: 📝 application.yml 생성
+ run: |
+ cd ./src/main/resources
+ touch ./application.yml
+ echo "${{ secrets.PROPERTIES }}" > ./application.yml
+ shell: bash
+
+ - name: 🚀 Redis 실행
+ uses: supercharge/redis-github-action@1.1.0
+ with:
+ redis-version: latest
+
+ - name: 🔧 빌드 권한 부여
+ run: chmod +x gradlew
+
+ - name: 🛠️ 테스트 프로파일 설정
+ run: echo "SPRING_PROFILES_ACTIVE=test" >> $GITHUB_ENV
+
+ - name: 🏗️ 프로젝트 빌드
+ run: ./gradlew clean build
+
+ - name: 📊 자코코 리포트 작성
+ uses: madrapps/jacoco-report@v1.6.1
+ with:
+ title: 📊 Jacoco Test Coverage
+ paths: ${{ github.workspace }}/**/build/reports/jacoco/test/jacocoTestReport.xml
+ token: ${{ secrets.GITHUB_TOKEN }}
+ min-coverage-overall: 80
+ min-coverage-changed-files: 0
+
+ - name: ✅ 테스트 리포트 작성
+ uses: mikepenz/action-junit-report@v4
+ with:
+ report_paths: '**/build/test-results/test/TEST-*.xml'
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..db4454d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,40 @@
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Secrets ###
+.application.properties
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..9fadf15
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,5 @@
+FROM openjdk:17-jdk
+LABEL authors="yerim"
+ARG JAR_FILE=build/libs/*SNAPSHOT.jar
+COPY ${JAR_FILE} /app.jar
+ENTRYPOINT ["java","-jar","/app.jar"]
\ No newline at end of file
diff --git a/build.gradle b/build.gradle
new file mode 100644
index 0000000..7d835eb
--- /dev/null
+++ b/build.gradle
@@ -0,0 +1,73 @@
+plugins {
+ id 'java'
+ id 'checkstyle'
+ id 'jacoco'
+ id 'org.springframework.boot' version '3.5.4'
+ id 'io.spring.dependency-management' version '1.1.7'
+}
+
+group = 'com.edu'
+version = '0.0.1-SNAPSHOT'
+
+java {
+ toolchain {
+ languageVersion = JavaLanguageVersion.of(17)
+ }
+}
+
+configurations {
+ compileOnly {
+ extendsFrom annotationProcessor
+ }
+}
+
+repositories {
+ mavenCentral()
+}
+
+dependencies {
+ // spring-boot-starter
+ implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+ implementation 'org.springframework.boot:spring-boot-starter-validation'
+ implementation 'org.springframework.boot:spring-boot-starter-web'
+ implementation 'org.springframework.boot:spring-boot-starter-data-redis'
+
+ // Swagger
+ implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.8'
+
+ // lombok
+ compileOnly 'org.projectlombok:lombok'
+ annotationProcessor 'org.projectlombok:lombok'
+
+ // mysql
+ runtimeOnly 'com.mysql:mysql-connector-j'
+
+ // test
+ testImplementation 'org.springframework.boot:spring-boot-starter-test'
+ testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+ testImplementation 'org.mockito:mockito-core:5.18.0'
+ testImplementation 'org.mockito:mockito-junit-jupiter:5.18.0'
+}
+
+compileJava.options.encoding = 'UTF-8'
+compileTestJava.options.encoding = 'UTF-8'
+
+checkstyle {
+ configFile = file("checkstyle/naver-checkstyle-rules.xml")
+ configProperties = ["suppressionFile": file("checkstyle/naver-checkstyle-suppressions.xml")]
+}
+
+jacoco {
+ toolVersion = '0.8.11'
+}
+
+jacocoTestReport {
+ reports {
+ html.required = true
+ xml.required = true
+ }
+}
+
+tasks.named('test') {
+ useJUnitPlatform()
+}
diff --git a/checkstyle/naver-checkstyle-rules.xml b/checkstyle/naver-checkstyle-rules.xml
new file mode 100644
index 0000000..9a35fca
--- /dev/null
+++ b/checkstyle/naver-checkstyle-rules.xml
@@ -0,0 +1,430 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/checkstyle/naver-checkstyle-suppressions.xml b/checkstyle/naver-checkstyle-suppressions.xml
new file mode 100644
index 0000000..a7b6fd1
--- /dev/null
+++ b/checkstyle/naver-checkstyle-suppressions.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 0000000..1b33c55
Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 0000000..d4081da
--- /dev/null
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
new file mode 100644
index 0000000..23d15a9
--- /dev/null
+++ b/gradlew
@@ -0,0 +1,251 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+##############################################################################
+#
+# Gradle start up script for POSIX generated by Gradle.
+#
+# Important for running:
+#
+# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+# noncompliant, but you have some other compliant shell such as ksh or
+# bash, then to run this script, type that shell name before the whole
+# command line, like:
+#
+# ksh Gradle
+#
+# Busybox and similar reduced shells will NOT work, because this script
+# requires all of these POSIX shell features:
+# * functions;
+# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+# * compound commands having a testable exit status, especially «case»;
+# * various built-in commands including «command», «set», and «ulimit».
+#
+# Important for patching:
+#
+# (2) This script targets any POSIX shell, so it avoids extensions provided
+# by Bash, Ksh, etc; in particular arrays are avoided.
+#
+# The "traditional" practice of packing multiple parameters into a
+# space-separated string is a well documented source of bugs and security
+# problems, so this is (mostly) avoided, by progressively accumulating
+# options in "$@", and eventually passing that to Java.
+#
+# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+# see the in-line comments for details.
+#
+# There are tweaks for specific operating systems such as AIX, CygWin,
+# Darwin, MinGW, and NonStop.
+#
+# (3) This script is generated from the Groovy template
+# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+# within the Gradle project.
+#
+# You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+ APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
+ [ -h "$app_path" ]
+do
+ ls=$( ls -ld "$app_path" )
+ link=${ls#*' -> '}
+ case $link in #(
+ /*) app_path=$link ;; #(
+ *) app_path=$APP_HOME$link ;;
+ esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+ echo "$*"
+} >&2
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in #(
+ CYGWIN* ) cygwin=true ;; #(
+ Darwin* ) darwin=true ;; #(
+ MSYS* | MINGW* ) msys=true ;; #(
+ NONSTOP* ) nonstop=true ;;
+esac
+
+CLASSPATH="\\\"\\\""
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD=$JAVA_HOME/jre/sh/java
+ else
+ JAVACMD=$JAVA_HOME/bin/java
+ fi
+ if [ ! -x "$JAVACMD" ] ; then
+ die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+else
+ JAVACMD=java
+ if ! command -v java >/dev/null 2>&1
+ then
+ die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+ case $MAX_FD in #(
+ max*)
+ # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
+ MAX_FD=$( ulimit -H -n ) ||
+ warn "Could not query maximum file descriptor limit"
+ esac
+ case $MAX_FD in #(
+ '' | soft) :;; #(
+ *)
+ # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
+ ulimit -n "$MAX_FD" ||
+ warn "Could not set maximum file descriptor limit to $MAX_FD"
+ esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+# * args from the command line
+# * the main class name
+# * -classpath
+# * -D...appname settings
+# * --module-path (only if needed)
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+ APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+ CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+ JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ for arg do
+ if
+ case $arg in #(
+ -*) false ;; # don't mess with options #(
+ /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
+ [ -e "$t" ] ;; #(
+ *) false ;;
+ esac
+ then
+ arg=$( cygpath --path --ignore --mixed "$arg" )
+ fi
+ # Roll the args list around exactly as many times as the number of
+ # args, so each arg winds up back in the position where it started, but
+ # possibly modified.
+ #
+ # NB: a `for` loop captures its iteration list before it begins, so
+ # changing the positional parameters here affects neither the number of
+ # iterations, nor the values presented in `arg`.
+ shift # remove old arg
+ set -- "$@" "$arg" # push replacement arg
+ done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+# and any embedded shellness will be escaped.
+# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+# treated as '${Hostname}' itself on the command line.
+
+set -- \
+ "-Dorg.gradle.appname=$APP_BASE_NAME" \
+ -classpath "$CLASSPATH" \
+ -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
+ "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+ die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+# set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+ printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+ xargs -n1 |
+ sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+ tr '\n' ' '
+ )" '"$@"'
+
+exec "$JAVACMD" "$@"
diff --git a/gradlew.bat b/gradlew.bat
new file mode 100644
index 0000000..db3a6ac
--- /dev/null
+++ b/gradlew.bat
@@ -0,0 +1,94 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/settings.gradle b/settings.gradle
new file mode 100644
index 0000000..8a9ba7e
--- /dev/null
+++ b/settings.gradle
@@ -0,0 +1 @@
+rootProject.name = 'kobridge'
diff --git a/src/main/java/com/edu/kobridge/KobridgeApplication.java b/src/main/java/com/edu/kobridge/KobridgeApplication.java
new file mode 100644
index 0000000..cddcf21
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/KobridgeApplication.java
@@ -0,0 +1,13 @@
+package com.edu.kobridge;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class KobridgeApplication {
+
+ public static void main(String[] args) {
+ SpringApplication.run(KobridgeApplication.class, args);
+ }
+
+}
diff --git a/src/main/java/com/edu/kobridge/global/common/BaseTime.java b/src/main/java/com/edu/kobridge/global/common/BaseTime.java
new file mode 100644
index 0000000..b3c0cc7
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/common/BaseTime.java
@@ -0,0 +1,26 @@
+package com.edu.kobridge.global.common;
+
+import java.time.LocalDateTime;
+
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.annotation.LastModifiedDate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.EntityListeners;
+import jakarta.persistence.MappedSuperclass;
+import lombok.Getter;
+
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener.class)
+@Getter
+public abstract class BaseTime {
+
+ @CreatedDate
+ @Column(name = "created_at", updatable = false)
+ private LocalDateTime createdAt;
+
+ @LastModifiedDate
+ @Column(name = "updated_at")
+ private LocalDateTime updatedAt;
+}
\ No newline at end of file
diff --git a/src/main/java/com/edu/kobridge/global/common/DataResponseDto.java b/src/main/java/com/edu/kobridge/global/common/DataResponseDto.java
new file mode 100644
index 0000000..44aca61
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/common/DataResponseDto.java
@@ -0,0 +1,28 @@
+package com.edu.kobridge.global.common;
+
+import org.springframework.http.HttpStatus;
+
+import lombok.Getter;
+
+@Getter
+public class DataResponseDto extends ResponseDto {
+ private final T data;
+
+ private DataResponseDto(T data, Integer code) {
+ super(code, HttpStatus.valueOf(code).getReasonPhrase());
+ this.data = data;
+ }
+
+ private DataResponseDto(T data, Integer code, String message) {
+ super(code, message);
+ this.data = data;
+ }
+
+ public static DataResponseDto of(T data, Integer code) {
+ return new DataResponseDto<>(data, code);
+ }
+
+ public static DataResponseDto of(T data, Integer code, String message) {
+ return new DataResponseDto<>(data, code, message);
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/com/edu/kobridge/global/common/ResponseDto.java b/src/main/java/com/edu/kobridge/global/common/ResponseDto.java
new file mode 100644
index 0000000..5f62ff1
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/common/ResponseDto.java
@@ -0,0 +1,27 @@
+package com.edu.kobridge.global.common;
+
+import org.springframework.http.HttpStatus;
+
+import com.edu.kobridge.global.error.ErrorCode;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public class ResponseDto {
+ private final Integer code;
+ private final String message;
+
+ public static ResponseDto of(Integer code) {
+ return new ResponseDto(code, HttpStatus.valueOf(code).getReasonPhrase());
+ }
+
+ public static ResponseDto of(Integer code, String message) {
+ return new ResponseDto(code, message);
+ }
+
+ public static ResponseDto of(ErrorCode e) {
+ return new ResponseDto(e.getHttpStatus().value(), e.getMessage());
+ }
+}
diff --git a/src/main/java/com/edu/kobridge/global/config/OpenApiConfig.java b/src/main/java/com/edu/kobridge/global/config/OpenApiConfig.java
new file mode 100644
index 0000000..37a6aa1
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/config/OpenApiConfig.java
@@ -0,0 +1,49 @@
+package com.edu.kobridge.global.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.servers.Server;
+
+@Configuration
+public class OpenApiConfig {
+
+ private static final String BEARER_TOKEN_PREFIX = "bearer";
+ private static final String securityJwtName = "JWT";
+
+ @Bean
+ public OpenAPI customOpenAPI() {
+ SecurityRequirement securityRequirement = new SecurityRequirement().addList(securityJwtName);
+
+ return new OpenAPI()
+ .addServersItem(new Server().url("/").description("현재 서버"))
+ .components(apiComponents())
+ .addSecurityItem(securityRequirement)
+ .info(apiInfo());
+ }
+
+ private Info apiInfo() {
+ return new Info()
+ .title("Kobridge API 명세서")
+ .description("다문화 가정 아이들을 위한 한국어 학습 보조 서비스 | Spring Boot를 이용한 REST API")
+ .version("0.0.1")
+ .contact(new io.swagger.v3.oas.models.info.Contact()
+ .name("이예림")
+ .url("https://github.com/yerim123456")
+ .email("yearim1226@naver.com"));
+ }
+
+ private Components apiComponents() {
+ return new Components()
+ .addSecuritySchemes(securityJwtName, new SecurityScheme()
+ .name(securityJwtName)
+ .type(SecurityScheme.Type.HTTP)
+ .scheme(BEARER_TOKEN_PREFIX)
+ .bearerFormat(securityJwtName));
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/com/edu/kobridge/global/error/ErrorCode.java b/src/main/java/com/edu/kobridge/global/error/ErrorCode.java
new file mode 100644
index 0000000..45342a8
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/error/ErrorCode.java
@@ -0,0 +1,11 @@
+package com.edu.kobridge.global.error;
+
+import org.springframework.http.HttpStatus;
+
+public interface ErrorCode {
+ String name();
+
+ HttpStatus getHttpStatus();
+
+ String getMessage();
+}
\ No newline at end of file
diff --git a/src/main/java/com/edu/kobridge/global/error/GlobalErrorCode.java b/src/main/java/com/edu/kobridge/global/error/GlobalErrorCode.java
new file mode 100644
index 0000000..1cf72eb
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/error/GlobalErrorCode.java
@@ -0,0 +1,20 @@
+package com.edu.kobridge.global.error;
+
+import org.springframework.http.HttpStatus;
+
+import lombok.Getter;
+
+@Getter
+public enum GlobalErrorCode implements ErrorCode {
+ MISSING_HEADER(HttpStatus.BAD_REQUEST, "필수 요청 헤더가 누락되었습니다."),
+ METHOD_NOT_ALLOWED(HttpStatus.METHOD_NOT_ALLOWED, "요청 경로가 지원되지 않습니다."),
+ INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "내부 서버 오류가 발생했습니다.");
+
+ private final HttpStatus httpStatus;
+ private final String message;
+
+ GlobalErrorCode(HttpStatus httpStatus, String message) {
+ this.httpStatus = httpStatus;
+ this.message = message;
+ }
+}
diff --git a/src/main/java/com/edu/kobridge/global/error/exception/AppException.java b/src/main/java/com/edu/kobridge/global/error/exception/AppException.java
new file mode 100644
index 0000000..d5e0827
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/error/exception/AppException.java
@@ -0,0 +1,18 @@
+package com.edu.kobridge.global.error.exception;
+
+import com.edu.kobridge.global.error.ErrorCode;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class AppException extends RuntimeException {
+ private ErrorCode errorCode;
+ private String message;
+
+ public AppException(ErrorCode errorCode) {
+ this.errorCode = errorCode;
+ this.message = errorCode.getMessage();
+ }
+}
diff --git a/src/main/java/com/edu/kobridge/global/error/handler/GlobalExceptionHandler.java b/src/main/java/com/edu/kobridge/global/error/handler/GlobalExceptionHandler.java
new file mode 100644
index 0000000..86c9372
--- /dev/null
+++ b/src/main/java/com/edu/kobridge/global/error/handler/GlobalExceptionHandler.java
@@ -0,0 +1,85 @@
+package com.edu.kobridge.global.error.handler;
+
+import java.util.Objects;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.web.HttpRequestMethodNotSupportedException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.MissingRequestHeaderException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+import com.edu.kobridge.global.common.ResponseDto;
+import com.edu.kobridge.global.error.ErrorCode;
+import com.edu.kobridge.global.error.GlobalErrorCode;
+import com.edu.kobridge.global.error.exception.AppException;
+
+import lombok.extern.slf4j.Slf4j;
+
+@RestControllerAdvice
+@Slf4j
+public class GlobalExceptionHandler {
+
+ // AppException
+ @ExceptionHandler(AppException.class)
+ public ResponseEntity exceptionHandler(AppException e) {
+ int code = e.getErrorCode().getHttpStatus().value();
+ String message = e.getMessage();
+
+ // 내부 서버 에러일 경우, stack trace 출력
+ if (code == 500)
+ e.printStackTrace();
+
+ return ResponseEntity.status(code).body(ResponseDto.of(code, message));
+ }
+
+ // HttpMessageNotReadableException
+ @ExceptionHandler(HttpMessageNotReadableException.class)
+ public ResponseEntity handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
+ int code = HttpStatus.BAD_REQUEST.value();
+ String message = Objects.requireNonNull(e.getRootCause()).getMessage();
+ return ResponseEntity.status(code).body(ResponseDto.of(code, message));
+ }
+
+ // MethodArgumentNotValidException
+ @ExceptionHandler(MethodArgumentNotValidException.class)
+ public ResponseEntity exceptionHandler(MethodArgumentNotValidException e) {
+ int code = HttpStatus.BAD_REQUEST.value();
+ String message = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
+ return ResponseEntity.status(code).body(ResponseDto.of(code, message));
+ }
+
+ // MethodNotAllowed
+ @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
+ public ResponseEntity exceptionHandler(HttpRequestMethodNotSupportedException e) {
+ ErrorCode errorCode = GlobalErrorCode.METHOD_NOT_ALLOWED;
+ int code = errorCode.getHttpStatus().value();
+ String message = errorCode.getMessage();
+
+ return ResponseEntity.status(code).body(ResponseDto.of(code, message));
+ }
+
+ // RequiredHeaderIsNotExist
+ @ExceptionHandler(MissingRequestHeaderException.class)
+ public ResponseEntity handleMissingRequestHeaderException(MissingRequestHeaderException e) {
+ ErrorCode errorCode = GlobalErrorCode.MISSING_HEADER;
+ int code = errorCode.getHttpStatus().value();
+ String message = errorCode.getMessage();
+
+ return ResponseEntity.status(code).body(ResponseDto.of(code, message));
+ }
+
+ // InternalServerError
+ @ExceptionHandler(Exception.class)
+ public ResponseEntity exceptionHandler(Exception e) {
+ ErrorCode errorCode = GlobalErrorCode.INTERNAL_SERVER_ERROR;
+ int code = errorCode.getHttpStatus().value();
+ String message = errorCode.getMessage();
+
+ e.printStackTrace();
+
+ return ResponseEntity.status(code).body(ResponseDto.of(code, message));
+ }
+}
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
new file mode 100644
index 0000000..75df091
--- /dev/null
+++ b/src/main/resources/application.yml
@@ -0,0 +1,27 @@
+spring:
+ application:
+ name: ${SPRING_APPLICATION_NAME}
+
+ datasource:
+ url: ${SPRING_DATASOURCE_URL}
+ username: ${SPRING_DATASOURCE_USERNAME}
+ password: ${SPRING_DATASOURCE_PASSWORD}
+ driver-class-name: com.mysql.cj.jdbc.Driver
+
+ jpa:
+ hibernate:
+ ddl-auto: update
+ show-sql: true
+ properties:
+ hibernate:
+ format_sql: true
+ dialect: org.hibernate.dialect.MySQL8Dialect
+
+ sql:
+ init:
+ mode: always
+
+server:
+ port: 8080
+ servlet:
+ context-path: /
diff --git a/src/test/java/com/edu/kobridge/KobridgeApplicationTests.java b/src/test/java/com/edu/kobridge/KobridgeApplicationTests.java
new file mode 100644
index 0000000..a8810ed
--- /dev/null
+++ b/src/test/java/com/edu/kobridge/KobridgeApplicationTests.java
@@ -0,0 +1,13 @@
+package com.edu.kobridge;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class KobridgeApplicationTests {
+
+ @Test
+ void contextLoads() {
+ }
+
+}