[feat] main branch pull request

.github/workflows/deploy.yml

@@ -0,0 +1,64 @@
+name: CD with Gradle
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'oracle'
+
+      - name: Make env file
+        run: |
+          echo "${{ secrets.ENV }}" | base64 --decode > .env
+
+      - name: Make docker-compose file
+        run: |
+          echo "\n" >> ./docker-compose.yml
+          echo "${{ secrets.DOCKER_COMPOSE }}" | base64 --decode >> ./docker-compose.yml
+          echo "\n" >> ./docker-compose.yml
+
+      - name: Grant execute permission for gradlew
+        run: |
+          chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+
+      - name: Docker Login
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Docker build & push to Docker repo
+        run: |
+          docker build -f Dockerfile -t ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }} .
+          docker push ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}
+
+      - name: Deploy to server
+        uses: appleboy/ssh-action@master
+        id: deploy
+        with:
+          host: ${{ secrets.AWS_HOST }}
+          username: ubuntu
+          key: ${{ secrets.AWS_SSH_KEY }}
+          envs: GITHUB_SHA
+          script: |
+            sudo docker rm -f $(docker ps -qa)
+            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}
+            sudo docker-compose up -d --build
+            sudo docker image prune -f

.github/workflows/gradle.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
+
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  build:
+    name: Build and test project
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'oracle'
+
+      - name: Make env file
+        run: |
+          echo "${{ secrets.ENV }}" | base64 --decode > .env
+
+      - name: Make docker-compose file
+        run: |
+          echo "\n" >> ./docker-compose.yml
+          echo "${{ secrets.DOCKER_COMPOSE }}" | base64 --decode >> ./docker-compose.yml
+          echo "\n" >> ./docker-compose.yml
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+
+      - name: Publish result of unit test
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: always()
+        with:
+          files: "**/build/test-results/test/TEST-*.xml"
+          github_token: ${{ github.token }}
+
+      - name: Publish failure of unit test
+        uses: mikepenz/action-junit-report@v3
+        if: always()
+        with:
+          report_paths: '**/build/test-results/test/TEST-*.xml'
+          github_token: ${{ github.token }}

.gitignore

@@ -35,3 +35,13 @@ out/
 
 ### VS Code ###
 .vscode/
+
+### ENV FILE ###
+.env
+
+### DATABASE/DATA Directory ###
+database/data/
+
+### REDIS/DATA Directory ###
+redis/data/
+/src/main/generated/com/haejwo/tripcometrue

Dockerfile

@@ -0,0 +1,8 @@
+FROM openjdk:17-jdk-slim
+WORKDIR /app
+COPY . .
+COPY .env .env
+ARG JAR_FILE_PATH=build/libs/*.jar
+COPY ${JAR_FILE_PATH} app.jar
+ENV TZ=Asia/Seoul
+ENTRYPOINT ["java", "-jar", "app.jar"]

README.md

@@ -1 +1,64 @@
-# TripComeTrue_BE
+### 👤팀원 소개
+
+|                                               Backend                                                |                                                                      Backend                                                                      |Backend|                                           Backend                                            |                                           Backend                                            |
+|:----------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------:|
+|       <img src="https://avatars.githubusercontent.com/u/65541248?v=4" width=130px alt="이유상"/>        |                           <img src="https://avatars.githubusercontent.com/u/55842092?s=64&v=4" width=130px alt="이주연"/>                            | <img src="https://avatars.githubusercontent.com/u/64956292?v=4" width=130px alt="백인권"/> | <img src="https://avatars.githubusercontent.com/u/85631282?s=64&v=4" width=130px alt="김동민"/> | <img src="https://avatars.githubusercontent.com/u/97028441?s=64&v=4" width=130px alt="박준모"/> |
+|                                 [이유상](https://github.com/liyusang1)                                  |                                                          [이주연](https://github.com/jo0oy)                                                          |[백인권](https://github.com/BackInGone)|                             [김동민](https://github.com/meena2003)                              |                              [박준모](https://github.com/junmo95)                               |
+| 💡spring security<br/> 💡회원가입 및 로그인 <br/>💡SNS 로그인 (카카오,네이버,구글) <br/>💡여행 후기 작성<br/> 💡여행 계획 작성 및 조회 | 💡Github Actions CI/CD, EC2, Docker<br/>💡홈 메인 피드 관련 api<br/>💡홈 검색 피드 관련 api<br/>💡도시 상세 관련 api<br/> 💡환율 open api 스케줄러 호출 및 환율 정보 redis 저장<br/> |💡마이 페이지 관련 api<br/>💡보관 기능 관련 api <br/>💡좋아요 관련 api    |  💡S3 이미지 업로드 삭제 관련 api <br/> 💡 여행 후기 리뷰 및 리뷰댓글 관련 api <br/> 💡여행지 리뷰 및 리뷰댓글 관련 api <br/>   |                 💡여행 후기 메인페이지 api<br/>💡여행 후기 상세페이지 api <br/>💡여행지 상세페이지 api                 |
+
+-----------------------
+### 📌기술스택 & 구현환경
+> -  Java : ![Java](https://img.shields.io/badge/java-17-red.svg)
+> -  FrameWork : ![Spring Boot](https://img.shields.io/badge/springboot-3.2.1-brightgreen.svg)  ![Spring Security](https://img.shields.io/badge/springsecurity-brightgreen.svg) ![Spring Data JPA](https://img.shields.io/badge/spring%20data%20JPA-brightgreen.svg)  ![Spring Web](https://img.shields.io/badge/spring%20web-brightgreen.svg)
+> -  Build : ![Gradle](https://img.shields.io/badge/Build-Gradle-blue.svg)
+> -  VCS : ![Git](https://img.shields.io/badge/VCS-Git-orange.svg) ![GitHub](https://img.shields.io/badge/Github-black.svg)
+> -  Database : ![GCP Cloud SQL](https://img.shields.io/badge/Database-AmazonEC2-yellow.svg)
+> -  DBMS : ![MySQL](https://img.shields.io/badge/DBMS-MySQL-blue.svg)
+> -  배포환경 : ![GCP VM](https://img.shields.io/badge/배포%20환경-AmazonEc2-blue.svg)
+> -  컨벤션 : ![Code Convention](https://img.shields.io/badge/Code%20Convention-IntelliJ%20Java%20Google%20Style-brightgreen.svg)
+> -  브랜치 전략 : ![GitFlow](https://img.shields.io/badge/GitFlow-Workflow-orange.svg)
+
+### 📌API 명세서 & 서비스 배포 주소
+- 서비스 배포 주소 : [https://tripcometrue.vercel.app](https://tripcometrue.vercel.app)
+- API 명세서:
+    - [Postman 1](https://documenter.getpostman.com/view/14269013/2s9YsJCYY9#47909ddc-026a-4731-b0ca-5088b8e8574f)
+    - [Postman 2](https://documenter.getpostman.com/view/24478928/2s9YsRaUDD)
+    - [Notion 1](https://arrow-halibut-e8d.notion.site/API-9d3aa3736a764af6a513efda552211b5?pvs=4)
+    - [Notion 2](https://immense-soarer-ecc.notion.site/TripComeTrue-API-4f9c4ca0580e47e49adfe3b62ec39957?pvs=4)
+
+
+### 📌패키지 구조
+```
+ com.example.yanolja  
+ ├── domain  
+ │   ├── alarm
+ │   ├── city
+ │   ├── comment
+ │   ├── likes
+ │   ├── member
+ │   ├── place
+ │   ├── review
+ │   ├── store
+ │   ├── tripplan
+ │   ├── triprecord
+ │   ...  
+ └── global  
+      ├── config
+      ├── entity
+      ├── enums
+      ├── exception
+      ├── jwt 
+      ├── s3
+      ├── springsecurity
+      ├── util
+      └── validator 
+```
+
+--------------------
+
+### ⭐ERD
+![erd](https://github.com/TripComeTrue/TripComeTrue_BE/assets/65541248/33ff36cc-0e04-4285-82d4-b2939e77b5ab)
+
+
+### ⭐Project Architecture
+![image](https://github.com/TripComeTrue/TripComeTrue_BE/assets/65541248/a6a64b92-2d77-4240-a64e-fe6770e1703e)

build.gradle

@@ -26,19 +26,80 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-security'
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
+	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+	testImplementation 'org.springframework.security:spring-security-test'
 	compileOnly 'org.projectlombok:lombok'
 
-	//mysql connector
+	// mysql connector
 	runtimeOnly 'com.mysql:mysql-connector-j'
 
+	// queryDSL 설정
+	implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+	annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
+	annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+	annotationProcessor "jakarta.persistence:jakarta.persistence-api"
+
+	// redis
+	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
+
+	// testcontainers
+	testImplementation 'org.springframework.boot:spring-boot-testcontainers'
+	testImplementation 'org.testcontainers:mysql'
+
 	annotationProcessor 'org.projectlombok:lombok'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testImplementation 'org.springframework.security:spring-security-test'
+	testAnnotationProcessor 'org.projectlombok:lombok'
+	testImplementation 'org.projectlombok:lombok'
 
 	// yml
 	implementation 'org.yaml:snakeyaml:+'
+
+	// dotenv-java
+	implementation 'io.github.cdimascio:java-dotenv:+'
+
+
+	// aws S3
+	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
+
+	//oauth
+	implementation("org.springframework.boot:spring-boot-starter-oauth2-client")
+
+	// jjwt
+	implementation 'io.jsonwebtoken:jjwt-api:0.11.2'
+	runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.2'
+	runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.2'
+
+	// httpclient5
+	implementation 'org.apache.httpcomponents.client5:httpclient5:5.3'
+}
+
+jar {
+	enabled = false
 }
 
 tasks.named('test') {
 	useJUnitPlatform()
 }
+
+
+// Querydsl 설정부
+// 아래 것들이 없어도 기본적인 querydsl 동작은 하나 인테리제이에서 빌드 시 발생할 문제를 예방
+def generated = 'src/main/generated'
+
+// querydsl QClass 파일 생성 위치를 지정
+// 원래 build 디렉토리 안에 있어서 눈에 안보였지만 꺼네서 내가 지정한 디렉토리에 꺼내옴
+// 인텔리제이 IDE와의 문제인데, 빌드 gradle 할때 스캔 영역이 달라서 중복 스캔이 발생할 수 있다.
+tasks.withType(JavaCompile) {
+	options.getGeneratedSourceOutputDirectory().set(file(generated))
+}
+
+// java source set 에 querydsl QClass 위치 추가
+sourceSets {
+	main.java.srcDirs += [ generated ]
+}
+
+// gradle clean 시에 QClass 디렉토리 삭제
+clean {
+	delete file(generated)
+}

database/Dockerfile

@@ -4,8 +4,6 @@ MAINTAINER [email protected]
 
 COPY init.sql /docker-entrypoint-initdb.d
 
-ENV MYSQL_ROOT_PASSWORD=root
-
 VOLUME /var/lib/mysql
 
 EXPOSE 3307

database/init.sql

@@ -1,6 +1,3 @@
-alter user 'root'@'localhost' identified with caching_sha2_password by 'root';
-flush privileges;
-
 create database if not exists tripcometrue;
 
-use tripcometrue;
+use tripcometrue;

docker-compose.yml

@@ -1,12 +1,23 @@
 version: '3'
+
+networks:
+  network:
+
 services:
-  travel-db:
+  tripcometrue-db:
     container_name: tripcometrue-db
-    build:
-      context: ./database
-      dockerfile: Dockerfile
+    image: jo0oy/tripcometrue-mysql
     ports:
       - "3307:3306"
+    environment:
+      - MYSQL_DATABASE=tripcometrue
+      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
+      - TZ=Asia/Seoul
+    volumes:
+      - ./database/data:/var/lib/mysql
+    command:
+      - --character-set-server=utf8mb4
+      - --collation-server=utf8mb4_unicode_ci
     restart: always
     healthcheck:
       test: [ "CMD", "mysqladmin" ,"ping", "-h", "localhost" ]
@@ -15,5 +26,20 @@ services:
     networks:
       - network
 
-networks:
-  network:
+  tripcometrue-redis:
+    container_name: tripcometrue-redis
+    image: redis:6
+    hostname: redis
+    command: redis-server --port 6379
+    ports:
+      - "6379:6379"
+    volumes:
+      - ./redis/data:/data
+    environment:
+      - TZ=Asia/Seoul
+    labels:
+      - "name=redis"
+      - "mode=standalone"
+    restart: always
+    networks:
+      - network

src/main/java/com/haejwo/tripcometrue/domain/alarm/controller/AlarmController.java

@@ -0,0 +1,30 @@
+package com.haejwo.tripcometrue.domain.alarm.controller;
+
+import com.haejwo.tripcometrue.domain.alarm.dto.response.AlarmResponseDto;
+import com.haejwo.tripcometrue.domain.alarm.service.AlarmService;
+import com.haejwo.tripcometrue.global.springsecurity.PrincipalDetails;
+import com.haejwo.tripcometrue.global.util.ResponseDTO;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequiredArgsConstructor
+public class AlarmController {
+
+  private final AlarmService alarmService;
+
+
+  @GetMapping("/v1/member/alarms")
+  public ResponseEntity<ResponseDTO<Page<AlarmResponseDto>>> getAlarms(
+      @AuthenticationPrincipal PrincipalDetails principalDetails,
+      Pageable pageable
+  ) {
+    Page<AlarmResponseDto> alarmsResponse = alarmService.getAlarms(principalDetails, pageable);
+    return ResponseEntity.ok(ResponseDTO.okWithData(alarmsResponse));
+  }
+}