[E팀] 백엔드파트 메인서버 코드리뷰용 PR

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: 추가될 기능에 대해 제안해주세요!
+title: "[✨FEATURE]"
+labels: "✨ Feature"
+assignees: ''
+
+---
+
+**🚀 기능 설명**
+추가하고 싶은 기능에 대해 명확하고 간결하게 설명해주세요.
+
+**🔍 원하는 솔루션 설명**
+
+**🙌 해야 할 일**
+- [ ] 할일 1
+- [ ] 할일 2
+- [ ] 할일 3
+
+**❓ 고려한 대안들**
+고려한 대체 솔루션이나 기능에 대해 설명해주세요.
+
+**📜 추가 내용**
+기능 요청에 대한 다른 맥락이나 스크린샷을 추가해주세요.

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## 📌 요약
+
+-
+
+## 📝 상세 내용
+
+-
+
+## 🗣️ 질문 및 이외 사항
+
+-
+
+### ☑️ 누구에게 리뷰를 요청할까요?

.github/workflows/ci-cd.yml

@@ -0,0 +1,89 @@
+name: 'CI/CD'
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  CI:
+    runs-on: ubuntu-latest
+    env:
+      KAKAO_CLIENT_ID: ${{ secrets.TEST_STRING_ENV }}
+      KAKAO_CLIENT_SECRET: ${{ secrets.TEST_STRING_ENV }}
+      KAKAO_REDIRECT_URI: ${{ secrets.TEST_STRING_ENV }}
+      JWT_SECRET_KEY: ${{ secrets.TEST_JWT_KEY }}
+      JWT_REFRESH_EXPIRE: ${{ secrets.TEST_INT_ENV }}
+      JWT_ACCESS_EXPIRE: ${{ secrets.TEST_INT_ENV }}
+      AWS_BUCKET_NAME: ${{ secrets.TEST_STRING_ENV }}
+      AWS_ACCESS_KEY: ${{ secrets.TEST_STRING_ENV }}
+      AWS_SECRET_KEY: ${{ secrets.TEST_STRING_ENV }}
+      AWS_REGION: 'ap-northeast-2'
+      FLASK_SERVER: ${{ secrets.TEST_STRING_ENV }}
+      FRONT_URL: ${{ secrets.TEST_STRING_ENV }}
+      BACKEND_DOMAIN: ${{ secrets.TEST_STRING_ENV }}
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v2
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Build with Gradle
+        run: ./gradlew build --no-daemon
+
+      - name: Run tests
+        run: ./gradlew test --no-daemon
+
+  CD:
+    if: ${{ github.event_name != 'pull_request' && success() }}
+    needs: CI
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Set up Docker Build
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build Docker image
+        run: |
+          docker compose build --no-cache
+          docker tag server ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPOSITORY }}:server
+          docker tag nginx ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPOSITORY }}:nginx
+
+      - name: Push Docker image to Docker Hub
+        run: |
+          docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPOSITORY }}:server
+          docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPOSITORY }}:nginx
+
+      - name: Deploy
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.EC2_HOST }}
+          username: ${{ secrets.EC2_USER }}
+          key: ${{ secrets.EC2_SSH_KEY }}
+          port: ${{ secrets.EC2_PORT }}
+          script: |
+            echo ${{ secrets.DOCKER_PASSWORD }} | sudo docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin
+
+            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPOSITORY }}:server
+            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPOSITORY }}:nginx
+            sudo docker pull prom/prometheus:latest
+            sudo docker pull grafana/grafana:latest
+
+            sudo docker-compose down
+            sudo docker-compose up -d
+            sudo docker image prune -f

.gitignore

@@ -0,0 +1,39 @@
+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/
+
+/src/main/resources/application-local.yml

README.md

@@ -1 +1,102 @@
-# claco-server
+# Claco 메인 서버 레포지토리
+
+## 🧑‍💻 R&R
+| Profile | Name | Role |
+| :---: | :---: | :---: |
+| <a href="https://github.com/devkeon"><img src="https://avatars.githubusercontent.com/u/121371840?v=4" height="120px"></a> | 이건(개발리드) <br> **devkeon**| 아키텍처 설계, ERD 설계, 메인 서버 인프라 및 CI/CD 구축, <br> 인증/인가, 모니터링 시스템 구축, 티켓/리뷰 기능,<br> 클라코북 기능, 회원 관련 기능|
+| <a href="https://github.com/anselmo228"><img src="https://avatars.githubusercontent.com/u/24919880?v=4" height="120px"></a> | 정희찬 <br> **anselmo**| ERD 설계, AI 및 배치 서버 인프라 및 CI/CD 구축, <br> 추천 AI 모델 구현, 배치 기능(데이터 로드) 구축, <br> 공연 기능, 공연 및 티켓 추천 기능|
+
+## 개발 내용
+
+### 📆 개발 기간
+- ***2024.10.05 ~ 2024.11.24***
+
+### 💻 개발 환경
+> Language: ```Java 17``` <br>
+> Framework: ```Spring Boot 3.3.4``` <br>
+> Database: ```MySQL 8.x``` <br>
+> ORM: ```JPA(Hibernate)``` <br>
+> CI/CD: ```Github Actions``` <br>
+> Cloud Platform: ```AWS(EC2, ALB, ACM), GCP(SQL)``` <br>
+> Test DB: ```testcontainer```
+
+### ⚙️ 개발 프로세스
+- ```TDD (테스트 주도 개발)``` : 구문 커버지리 (Statement coverage) 기준 80%를 목표로 수행 
+- ```Agile (애자일 프로세스)``` : 1주 단위 스프린트 수행
+- ```Github Flow 전략``` : 초기 개발 과정에서 불필요한 브랜치 관리를 피하고, 빠른 배포를 위한 전략 선택
+- ```CI/CD 파이프라인을 통한 배포 자동화``` : 서비스 개발이 50% 완료된 시점에서 구축하여 배포 자동화
+
+### 💫 TDD 결과
+- Service는 단위 테스트, Repository는 통합 테스트 진행
+- ```testcontainer```를 활용하여 데이터베이스 멱등성 보장
+- 테스트 코드 커버리지 측정 툴: ```IntelliJ``` <br>
+
+![img.png](readme/test-coverage.png)
+- summary
+  - statement coverage 기준: 88%
+  - branch coverage: 54.8%
+  - class coverage: 100%
+  - method coverage: 96.7%
+
+### 💫 부하 테스트 결과
+- 사용 인스턴스 유형: ```t2.large (ram 8GB)```
+- 부하 테스트 측정 툴: ```Jmeter```
+
+![server-test.png](readme/server-test.png)
+- summary
+  - 도메인별 주요 api 평균 50.3 Throughput
+
+## 🏛️ 아키텍처
+![architecture.png](readme/architecture.png)
+
+### 보안 고려 사항
+- JWT를 활용한 인증/인가
+  - SSL 보안 계층을 활용한 토큰 암호화 (HTTPS, ALB 설치)
+  - CSRF / XSS 공격에 대비한 토큰 저장 분리 (Local storage, HTTP-only Cookie)
+- Nginx를 활용한 actuator와 같은 민감 정보 deny
+- Spring Security를 활용한 철저한 Auth 검사 및 uri 접근 조정
+- Kakao OAuth2.0을 활용한 인증/인가 기능 간편화
+- docker 네트워크를 활용하여 spring 서버나, prometheus같은 인스턴스 포트 매핑x (Endpoint 단일화)
+
+### 추천 시스템 로직
+
+- Collaborative Filtering & Cosine Similarity 기반 추천시스템
+  1. 각 Concert는 AI가 추출해준 키워드 값에 대해 0 ~ 1 사이의 값을 가짐
+  2. 유저도 마찬가지로 온보딩에서 등록한 취향 정보로 부터 모든 키워드 값에 대해 0 ~ 1사이 값을 가짐
+  3. Concerts, Users CSV파일을 통해서 Cosine Similarity와 Collaborative Filtering을 통한 유사도 계산 후 추천 진행
+
+### 메인 서버
+- 서비스의 주요 로직을 처리하는 서버
+- Grafana와 Prometheus에 기반한 모니터링 시스템 구축
+- Nginx를 통한 리버스 프록시 설정
+
+### AI 서버
+
+- 공연 성격 분석이나, 유저 성격 분석, OCR을 처리하는 서버
+- OCR 및 공연 성격 정보 추출은 NCP의 AI 서비스를 활용
+- 추천 시스템의 경우 직접 Collaborative Filtering Model 구현
+
+### 배치 서버
+
+- KOPIS 시스템으로부터 공연 정보를 주기적으로 업데이트하는 서버(한달에 1번)
+- KOPIS에서 데이터를 받아올때마다 AI서버에 학습 요청
+
+### 🔄 FlowChart of AI & Batch Server
+![flow-chart.png](readme/ai-flow.png)
+
+## 📁 ERD
+![erd.png](readme/erd.png)
+
+- 카테고리에서 연관 관계 설정을 통해 관계형 데이터베이스 활용
+- AI 서비스 학습을 위한 soft delete 활용
+
+## 🛠️ CI/CD pipeline
+![ci-cd.png](readme/cicd.png)
+1. PR 이벤트 발생 시 CI 실행 (테스트 포함)
+2. approve 및 CI 성공 시 merge 가능 
+3. merge 이벤트 발생 시 CI 스크립트 수행 
+4. CI 스크립트 성공 시 CD 스크립트 수행
+5. Docker 이미지 docker hub에 push 
+6. SSH로 AWS EC2 연결
+7. docker hub에서 이미지 pull
+8. dokcer-compose를 활용해 서비스 실행 및 도커 네트워크 구축

build.gradle

@@ -0,0 +1,70 @@
+plugins {
+	id 'java'
+	id 'org.springframework.boot' version '3.3.4'
+	id 'io.spring.dependency-management' version '1.1.6'
+}
+
+group = 'com.curateme'
+version = '0.0.1-SNAPSHOT'
+
+java {
+	toolchain {
+		languageVersion = JavaLanguageVersion.of(17)
+	}
+}
+
+configurations {
+	compileOnly {
+		extendsFrom annotationProcessor
+	}
+}
+
+repositories {
+	mavenCentral()
+}
+
+dependencies {
+	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+	implementation 'org.springframework.boot:spring-boot-starter-mail'
+	implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
+	implementation 'org.springframework.boot:spring-boot-starter-security'
+	implementation 'org.springframework.boot:spring-boot-starter-validation'
+	implementation 'org.springframework.boot:spring-boot-starter-web'
+
+	// JWT dependencies
+	implementation 'io.jsonwebtoken:jjwt-api:0.12.3'
+	runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.12.3'
+	runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.12.3'
+
+	// S3
+	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
+
+	// Testcontainer
+	testImplementation 'org.springframework.boot:spring-boot-testcontainers'
+	testImplementation 'org.testcontainers:mysql'
+
+	// Actuator
+	implementation 'org.springframework.boot:spring-boot-starter-actuator'
+	implementation 'io.micrometer:micrometer-registry-prometheus'
+
+	testCompileOnly 'org.projectlombok:lombok'
+	testAnnotationProcessor 'org.projectlombok:lombok'
+
+	implementation 'org.springframework.boot:spring-boot-starter-json'
+
+
+	compileOnly 'org.projectlombok:lombok'
+	runtimeOnly 'com.h2database:h2'
+	runtimeOnly 'com.mysql:mysql-connector-j'
+	annotationProcessor 'org.projectlombok:lombok'
+	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+	testImplementation 'org.springframework.security:spring-security-test'
+	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+	// swagger
+	implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.2.0'
+}
+
+tasks.named('test') {
+	useJUnitPlatform()
+}

docker-compose.yml

@@ -0,0 +1,19 @@
+version: "3.8"
+
+services:
+  server:
+    build:
+      context: .
+      dockerfile: ./dockerfiles/dockerfile-server
+    image: server
+    container_name: server
+    env_file:
+      - ~/env.list
+  nginx:
+    build:
+      context: ./dockerfiles
+      dockerfile: dockerfile-nginx
+    image: nginx
+    container_name: nginx
+    ports:
+      - "80:80"

dockerfiles/dockerfile-nginx

@@ -0,0 +1,7 @@
+FROM nginx:latest
+
+COPY nginx.conf /etc/nginx/nginx.conf
+
+EXPOSE 80
+
+CMD ["nginx", "-g", "daemon off;"]

dockerfiles/dockerfile-server

@@ -0,0 +1,9 @@
+FROM gradle:8.8-jdk17 AS build
+
+COPY --chown=gradle:gradle ../ /home/gradle/src
+WORKDIR /home/gradle/src
+RUN gradle build --no-daemon --warning-mode=all --scan -x test
+
+FROM openjdk:17
+COPY --from=build /home/gradle/src/build/libs/*.jar /app/spring-boot-application.jar
+ENTRYPOINT ["java", "-Duser.timezone=Asia/Seoul", "-jar", "/app/spring-boot-application.jar"]