[BE] release: 백엔드 운영 서버 배포 v1.0.0

.github/workflows/be-merge-dev.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
 
   pull_request:
-    branches: [ develop ]
+    branches: [ develop-BE ]
     types: [ closed ]
     paths: backend/**
 
@@ -19,12 +19,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+        token: ${{ secrets.SUBMODULE_ACCESS_TOKEN }}
     - name: Set up JDK 17
       uses: actions/setup-java@v3
       with:
         java-version: '17'
         distribution: 'temurin'
-        
+
     - name: 테스트 환경변수 설정
       run: |
         echo "TEST_JWT_SECRET_KEY=${{ secrets.TEST_JWT_SECRET_KEY }}" >> $GITHUB_ENV

.github/workflows/be-merge-prod.yml

@@ -18,31 +18,34 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        java-version: '17'
-        distribution: 'temurin'
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          token: ${{ secrets.SUBMODULE_ACCESS_TOKEN }}
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: 테스트 환경변수 설정
+        run: |
+          echo "TEST_JWT_SECRET_KEY=${{ secrets.TEST_JWT_SECRET_KEY }}" >> $GITHUB_ENV
+          echo "TEST_JWT_EXPIRE_LENGTH=${{ secrets.TEST_JWT_EXPIRE_LENGTH }}" >> $GITHUB_ENV
 
-    - name: 테스트 환경변수 설정
-      run: |
-        echo "TEST_JWT_SECRET_KEY=${{ secrets.TEST_JWT_SECRET_KEY }}" >> $GITHUB_ENV
-        echo "TEST_JWT_EXPIRE_LENGTH=${{ secrets.TEST_JWT_EXPIRE_LENGTH }}" >> $GITHUB_ENV
+      - name: gradlew 실행 권한 부여
+        run: chmod +x gradlew
+        working-directory: backend
 
-    - name: gradlew 실행 권한 부여
-      run: chmod +x gradlew
-      working-directory: backend
+      - name: Gradle build 시작
+        run: ./gradlew clean build
+        working-directory: backend
 
-    - name: Gradle build 시작
-      run: ./gradlew clean build
-      working-directory: backend
-
-    - name: jar 파일 artifact에 업로드
-      uses: actions/upload-artifact@v3
-      with:
-        name: BackendApplication
-        path: backend/build/libs/mapbefine.jar
+      - name: jar 파일 artifact에 업로드
+        uses: actions/upload-artifact@v3
+        with:
+          name: BackendApplication
+          path: backend/build/libs/mapbefine.jar
 
   deploy:
     runs-on: [ self-hosted, prod ]

.github/workflows/be-pull-request.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
 
   pull_request:
-    branches: [ main, develop ]
+    branches: [ main, develop-BE ]
     paths: backend/**
 
 permissions:
@@ -18,35 +18,38 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        java-version: '17'
-        distribution: 'temurin'
-
-    - name: 테스트 환경변수 설정
-      run: |
-        echo "TEST_JWT_SECRET_KEY=${{ secrets.TEST_JWT_SECRET_KEY }}" >> $GITHUB_ENV
-        echo "TEST_JWT_EXPIRE_LENGTH=${{ secrets.TEST_JWT_EXPIRE_LENGTH }}" >> $GITHUB_ENV
-
-    - name: gradlew 실행 권한 부여
-      run: chmod +x gradlew
-      working-directory: backend
-
-    - name: Gradle build 시작
-      run: ./gradlew clean build
-      working-directory: backend
-
-    - name: 테스트 결과를 PR에 코멘트로 등록합니다
-      uses: EnricoMi/publish-unit-test-result-action@v1
-      if: always()
-      with:
-        files: 'backend/build/test-results/test/TEST-*.xml'
-
-    - name: 테스트 실패 시, 실패한 코드 라인에 Check 코멘트를 등록합니다
-      uses: mikepenz/action-junit-report@v3
-      if: always()
-      with:
-        report_paths: '**/build/test-results/test/TEST-*.xml'
-        token: ${{ github.token }}
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+          token: ${{ secrets.SUBMODULE_ACCESS_TOKEN }}
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: 테스트 환경변수 설정
+        run: |
+          echo "TEST_JWT_SECRET_KEY=${{ secrets.TEST_JWT_SECRET_KEY }}" >> $GITHUB_ENV
+          echo "TEST_JWT_EXPIRE_LENGTH=${{ secrets.TEST_JWT_EXPIRE_LENGTH }}" >> $GITHUB_ENV
+
+      - name: gradlew 실행 권한 부여
+        run: chmod +x gradlew
+        working-directory: backend
+
+      - name: Gradle build 시작
+        run: ./gradlew clean build
+        working-directory: backend
+
+      - name: 테스트 결과를 PR에 코멘트로 등록합니다
+        uses: EnricoMi/publish-unit-test-result-action@v1
+        if: always()
+        with:
+          files: 'backend/build/test-results/test/TEST-*.xml'
+
+      - name: 테스트 실패 시, 실패한 코드 라인에 Check 코멘트를 등록합니다
+        uses: mikepenz/action-junit-report@v3
+        if: always()
+        with:
+          report_paths: '**/build/test-results/test/TEST-*.xml'
+          token: ${{ github.token }}

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "backend/src/main/resources/config"]
+	path = backend/src/main/resources/config
+	url = https://github.com/map-befine-official/map-befine-config.git

backend/.gitignore

@@ -35,6 +35,3 @@ out/
 
 ### VS Code ###
 .vscode/
-
-### Logging ###
-.log

backend/build.gradle

@@ -28,6 +28,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.springframework.boot:spring-boot-starter-validation'
     implementation 'org.springframework.boot:spring-boot-starter-webflux'
+    implementation group: 'com.github.maricn', name: 'logback-slack-appender', version: '1.6.1'
 
     implementation 'mysql:mysql-connector-java:8.0.32'
 
@@ -44,6 +45,10 @@ dependencies {
     testImplementation 'io.rest-assured:spring-mock-mvc'
     testImplementation 'org.assertj:assertj-core:3.19.0'
 
+    // S3
+    implementation platform('com.amazonaws:aws-java-sdk-bom:1.11.1000')
+    implementation 'com.amazonaws:aws-java-sdk-s3'
+
     compileOnly 'org.projectlombok:lombok'
     runtimeOnly 'com.h2database:h2'
 

backend/docs/README.md

@@ -39,19 +39,19 @@
 
 - 핀 상세 조회
 
-#### 유저 핀
+#### 회원 핀
 
-- 유저 핀 생성
+- 회원 핀 생성
 
-- 유저 핀 정보 수정
+- 회원 핀 정보 수정
     - name, description 만 수정 가능하다.
     - description 은 1000자 까지만 가능하다.
 
-- 유저 핀 삭제
+- 회원 핀 삭제
     - Delete 는 Soft Delete
 
 ---
 
-- 유저 핀 목록 조회
+- 회원 핀 목록 조회
     - 페이지 네이션 (무한 스크롤, 일단 15개)
 

backend/src/docs/asciidoc/admin.adoc

@@ -0,0 +1,29 @@
+== 관리자 기능
+
+=== 전체 회원 조회
+
+operation::admin-controller-test/find-all-member-details[snippets='http-request,http-response']
+
+=== 회원 상세 조회
+
+operation::admin-controller-test/find-member[snippets='http-request,http-response']
+
+=== 회원 차단(삭제)
+
+operation::admin-controller-test/delete-member[snippets='http-request,http-response']
+
+=== 토픽 삭제
+
+operation::admin-controller-test/delete-topic[snippets='http-request,http-response']
+
+=== 토픽 이미지 삭제
+
+operation::admin-controller-test/delete-topic-image[snippets='http-request,http-response']
+
+=== 핀 삭제
+
+operation::admin-controller-test/delete-pin[snippets='http-request,http-response']
+
+=== 핀 이미지 삭제
+
+operation::admin-controller-test/delete-pin-image[snippets='http-request,http-response']

backend/src/docs/asciidoc/auth.adoc

@@ -0,0 +1,13 @@
+== 소셜 로그인
+
+=== KAKAO 로그인 URL 반환
+
+operation::login-controller-test/redirection[snippets='http-request,http-response']
+
+=== KAKAO 로그인
+
+operation::login-controller-test/login[snippets='http-request,http-response']
+
+=== 로그아웃
+
+operation::login-controller-test/logout[snippets='http-request,http-response']

backend/src/docs/asciidoc/bookmark.adoc

@@ -1,10 +1,10 @@
 == 즐겨찾기
 
-=== 토픽을 유저의 즐겨찾기에 추가
+=== 토픽을 회원의 즐겨찾기에 추가
 
 operation::bookmark-controller-test/add-topic-in-bookmark[snippets='http-request,http-response']
 
 
-=== 유저의 토픽 즐겨찾기 삭제
+=== 회원의 토픽 즐겨찾기 삭제
 
 operation::bookmark-controller-test/delete-topic-in-bookmark[snippets='http-request,http-response']

backend/src/docs/asciidoc/index.adoc

@@ -13,5 +13,6 @@ include::pin.adoc[]
 include::atlas.adoc[]
 include::member.adoc[]
 include::permission.adoc[]
-include::oauth.adoc[]
+include::auth.adoc[]
 include::bookmark.adoc[]
+include::admin.adoc[]

backend/src/docs/asciidoc/member.adoc

@@ -1,25 +1,29 @@
-== 유저
+== 회원
 
-=== 유저 목록 조회
+=== 회원 목록 조회
 
 operation::member-controller-test/find-all-member[snippets='http-request,http-response']
 
-=== 유저 단일 조회
+=== 회원 단일 조회
 
 operation::member-controller-test/find-member-by-id[snippets='http-request,http-response']
 
-=== 유저의 나의 지도 목록 조회
+=== 회원의 나의 지도 목록 조회
 
 operation::member-controller-test/find-my-all-topics[snippets='http-request,http-response']
 
-=== 유저의 나의 핀 목록 조회
+=== 회원의 나의 핀 목록 조회
 
 operation::member-controller-test/find-my-all-pins[snippets='http-request,http-response']
 
-=== 유저의 모아보기 조회
+=== 회원의 모아보기 조회
 
 operation::member-controller-test/find-all-topics-in-atlas[snippets='http-request,http-response']
 
-=== 유저의 즐겨찾기 조회
+=== 회원의 즐겨찾기 조회
 
 operation::member-controller-test/find-all-topics-in-bookmark[snippets='http-request,http-response']
+
+=== 회원의 내 정보 수정
+
+operation::member-controller-test/update-my-info[snippets='http-request,http-response']

backend/src/docs/asciidoc/permission.adoc

@@ -8,10 +8,10 @@ operation::permission-controller-test/add-permission[snippets='http-request,http
 
 operation::permission-controller-test/delete-permission[snippets='http-request,http-response']
 
-=== 토픽에 권한을 가진 유저 목록 조회
+=== 토픽 접근 정보(권한 회원 목록 및 공개 여부) 조회
 
-operation::permission-controller-test/find-all-topic-permissions[snippets='http-request,http-response']
+operation::permission-controller-test/find-topic-access-detail-by-topic-id[snippets='http-request,http-response']
 
-=== 토픽에 권한을 가진 유저 단일 조회
+=== 토픽에 권한을 가진 회원 단일 조회
 
 operation::permission-controller-test/find-permission-by-id[snippets='http-request,http-response']

backend/src/docs/asciidoc/pin.adoc

@@ -8,7 +8,7 @@ operation::pin-controller-test/find-all[snippets='http-request,http-response']
 
 operation::pin-controller-test/find-by-id[snippets='http-request,http-response']
 
-=== 멤버별 핀 목록 조회
+=== 회원별 핀 목록 조회
 
 operation::pin-controller-test/find-all-pins-by-member-id[snippets='http-request,http-response']