merge : develop -> main 병합

.env

@@ -0,0 +1,8 @@
+DB_NAME=${{ secrets.DB_NAME }}
+DB_USERNAME=${{ secrets.DB_PASSWORD }}
+DB_PASSWORD=${{ secrets.DB_USERNAME }}
+
+
+BUCKET_ACCESSKEY=${{ secrets.BUCKET_ACCESSORY }}
+BUCKET_SECRETKEY=${{ secrets.BUCKET_SECRETARY }}
+BUCKET_NAME=${{ secrets.BUCKET_NAME }}

.github/workflows/gradle-publish.yml

@@ -0,0 +1,58 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a package using Gradle and then publish it to GitHub packages when a release is created
+# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#Publishing-using-gradle
+
+name: Gradle Package
+
+on: [ push ]
+
+  # https://github.com/marketplace/actions/build-and-push-docker-images
+jobs:
+  docker-build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ vars.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      -
+        name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          file: /build/libs/*
+          push: true
+          tags: ${{ vars.DOCKERHUB_USERNAME }}/${{ vars.DOCKER_IMAGE_TAG_NAME }}:latest
+  # Ec2 에 배포
+  deploy-to-ec2:
+    needs: docker-build-and-push
+    runs-on: ubuntu-latest
+    # https://github.com/marketplace/actions/ssh-remote-commands
+    steps:
+      - name: Deploy to EC2
+        uses: appleboy/ssh-action@v1.2.0
+        with:
+          host: ${{ secrets.EC2_HOST }}
+          username: ${{ secrets.EC2_USER }}
+          key: ${{ secrets.EC2_KEY }}
+          script: |
+            CONTAINER_ID=$(sudo docker ps -q --filter "publish=8080-8080")
+
+            if [ ! -z "$CONTAINER_ID" ]; then
+              sudo docker stop $CONTAINER_ID
+              sudo docker rm $CONTAINER_ID
+            fi
+
+            sudo docker pull ${{ vars.DOCKERHUB_USERNAME }}/${{ vars.DOCKER_IMAGE_TAG_NAME }}:latest
+            sudo docker run -d -p 8080:8080 \
+                ${{ vars.DOCKERHUB_USERNAME }}/${{ vars.DOCKER_IMAGE_TAG_NAME }}:latest

Docker-compose.yml

@@ -0,0 +1,38 @@
+version: '3'
+services:
+  app:
+    image: trello:latest
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "8080:8080"
+    environment:
+      BUCKET_ACCESSKEY: ${BUCKET_ACCESSKEY}
+      BUCKET_SECRETKEY: ${BUCKET_SECRETKEY}
+      BUCKET_NAME: ${BUCKET_NAME}
+      SPRING_DATASOURCE_URL: jdbc:mysql://db:3306/trello?serverTimezone=Asia/Seoul&useSSL=false&allowPublicKeyRetrieval=true
+      SPRING_DATASOURCE_USERNAME: root
+      SPRING_DATASOURCE_PASSWORD: 1111
+    depends_on:
+      - db
+
+  db:
+    image: mysql:8.0
+    container_name: my-mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: 1111
+      MYSQL_DATABASE: trello
+      MYSQL_USER: demo
+      MYSQL_PASSWORD: demo
+    ports:
+      - "3307:3306"
+    volumes:
+      - db_data:/var/lib/mysql
+    command:
+      - --character-set-server=utf8mb4
+      - --collation-server=utf8mb4_unicode_ci
+      - --default-authentication-plugin=mysql_native_password
+
+volumes:
+  db_data:

Dockerfile

@@ -0,0 +1,24 @@
+FROM eclipse-temurin:17-jdk-alpine
+
+ARG JAR_FILE=build/libs/*.jar
+
+COPY ${JAR_FILE} app.jar
+
+ENTRYPOINT ["java", "-jar", "/app.jar"]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

README.md

@@ -0,0 +1,72 @@
+# Trello TeamProject 
+---
+## 🦹‍ 12조 3FT1 팀원소개
+|<img src="https://avatars.githubusercontent.com/u/183330093?v=4" width="150" height="150"/>|<img src="https://avatars.githubusercontent.com/u/183330589?v=4" width="150" height="150"/>|<img src="https://avatars.githubusercontent.com/u/174124185?v=4" width="150" height="150"/>|<img src="https://avatars.githubusercontent.com/u/183378078?v=4" width="150" height="150"/>|
+|:-:|:-:|:-:|:-:|
+|강준혁|고강혁|천준민|장우태|
+|kangjunhyuk1<br/>[@kangjunhyuk1](https://github.com/kangjunhyuk1)|Newbiekk<br/>[@Newbiekk-kkh](https://github.com/Newbiekk-kkh)|2unmini<br/>[@2unmini](https://github.com/2unmini)|jangutae<br/>[@jangutae](https://github.com/jangutae)|
+---
+## 🛠️ Tools :  <img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white"> <img src="https://img.shields.io/badge/spring-6DB33F?style=for-the-badge&logo=github&logoColor=Green"> <img alt="Java" src ="https://img.shields.io/badge/Java-007396.svg?&style=for-the-badge&logo=Java&logoColor=white"/>  <img alt="Java" src ="https://img.shields.io/badge/intellijidea-000000.svg?&style=for-the-badge&logo=intellijidea&logoColor=white"/> ![Amazon S3](https://img.shields.io/badge/Amazon%20S3-FF9900?style=for-the-badge&logo=amazons3&logoColor=white) ![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white) ![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)
+- MySql 8.0
+- Java 17
+- SpringBoot 3.4.1
+---
+## 👨‍💻 Period : 2024/12/23 ~ 2024/12/30
+---
+## 👨‍💻 ERD
+![image](https://github.com/user-attachments/assets/aba1e1ad-adc4-47e4-95e6-b416657efee3)
+
+
+---
+## 👨‍💻 API명세서
+
+![플러스](https://github.com/user-attachments/assets/1833f1c6-2298-4244-bc2a-dbb4ecb02ff2)
+
+---
+## 👨‍💻 About Project
+
+- 회원가입/로그인
+  - Spring security, JWT 를 사용해 인증 구현
+  - 아이디는 이메일 형식 
+  - 탈퇴한 이메일 재사용 불가능 (회원 삭제를 STATUS ENUM 으로 관리)
+  - 비밀번호는 대소문자 포함 영문 + 숫자 + 특수문자 최소 1글자씩 포함 
+  - 역할(ADMIN, USER) 에 따라 권한 부여
+
+- 워크스페이스
+  - 제목, 설명, 슬랙URL 로 구성
+  - ADMIN 역할인 회원만 생성 가능
+  - 수정, 삭제 등 관리는 WORKSPACE 멤버역할을 가진 멤버만 가능
+
+- 워크스페이스 멤버
+  - 멤버 역할(WORKSPACE, BOARD, READ_ONLY)로 구성
+  - ADMIN 역할을 가진 회원만 WORKSPACE 역할 부여 가능
+  - 워크스페이스 멤버 초대는 WORKSPACE 역할만 가능
+
+- 보드
+  - READ_ONLY 역할을 제외한 워크스페이스의 멤버만 생성, 수정, 삭제 가능
+  - 보드는 제목, 배경색, 이미지 설정 가능
+  - 배경으로 쓸 이미지 업로드 기능 구현 (jpg, png, jpeg, gif 이외의 확장자는 업로드 불가능)
+  - 단일 조회시, 보드에 속한 리스트, 카드 전체 조회 가능
+
+- 리스트
+  - READ_ONLY 역할을 제외한 워크스페이스의 멤버만 생성, 수정, 삭제 가능
+  - 리스트는 제목, 순서 설정 가능
+
+- 카드
+  - READ_ONLY 역할을 제외한 워크스페이스의 멤버만 생성, 수정, 삭제 가능
+  - 카드는 제목, 설명, 마감일, 담당자 멤버 등을 추가 가능
+  - 카드의 제목, 내용, 마감일, 담당자 이름 등을 기준으로 페이징하여 검색 (쿼리DSL 활용)
+  - 첨부파일 기능 구현 (첨부파일 업로드, 삭제, 조회) / 정해진 확장자(jpg, png, jpeg, gif, pdf, csv) 이외는 업로드 불가능
+
+- 댓글
+  - 카드 내에 댓글 작성 기능 ( 텍스트와 이모지 작성 )
+  - READ_ONLY 역할을 제외한 워크스페이스의 멤버만 생성 가능
+  - 댓글은 작성자만 수정, 삭제 가능
+
+- 알림
+  - 멤버 추가 / 카드 변경 / 댓글 작성 시 워크스페이스 생성시 등록했던 슬랙Url로 실시간 알림 제공
+---
+
+## 😭 아쉬운점
+- 제출 당일 새벽 4시까지 팀원들 모두가 모여서 CI/CD 배포를 하려했으나, 지속되는 오류에 포기한 점이 아쉽습니다. 다음 최종 프로젝트에선 꼭 누락되는 기능 없이 구현해보고 싶습니다.
+- Spring security 로 인증은 구현하였으나, 인가는 구현하지 못했습니다. 이또한 추가적인 학습 후에 구현해보고 싶습니다.

build.gradle

@@ -28,18 +28,30 @@ 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'
+    implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
     compileOnly 'org.projectlombok:lombok'
     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'
 
+    // JWT
+    compileOnly 'io.jsonwebtoken:jjwt-api:0.12.3'
+    runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.12.3'
+    runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.12.3'
+
     // 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"
+
+    //Slack
+    implementation 'com.slack.api:slack-api-client:1.27.2'
+
+    // Apache Commons IO 라이브러리
+    implementation 'commons-io:commons-io:2.11.0'
 }
 
 tasks.named('test') {

src/main/java/com/example/trello/board/Board.java

@@ -3,6 +3,7 @@
 import com.example.trello.cardlist.CardList;
 import com.example.trello.workspace.Workspace;
 import jakarta.persistence.*;
+import lombok.Builder;
 import lombok.Getter;
 
 import java.util.List;
@@ -15,11 +16,12 @@ public class Board {
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
 
-    @Column(name = "title")
+    @Column(name = "title", nullable = false)
     private String title;
 
     @Column(name = "color")
-    private String color;
+    @Enumerated(EnumType.STRING)
+    private BoardColor color;
 
     @Column(name = "image")
     private String image;
@@ -30,4 +32,20 @@ public class Board {
     @OneToMany(mappedBy = "board", cascade = CascadeType.ALL, orphanRemoval = true)
     private List<CardList> cardLists;
 
+    public Board() {
+    }
+
+    @Builder
+    public Board(String title, BoardColor color, String image, Workspace workspace) {
+        this.title = title;
+        this.color = color;
+        this.image = image;
+        this.workspace = workspace;
+    }
+
+    public void updateBoard(String title, BoardColor color, String image) {
+        this.title = title;
+        this.color = color;
+        this.image = image;
+    }
 }

src/main/java/com/example/trello/board/BoardColor.java

@@ -0,0 +1,12 @@
+package com.example.trello.board;
+
+public enum BoardColor {
+    BLACK,
+    BLUE,
+    RED,
+    WHITE,
+    ORANGE,
+    PURPLE,
+    YELLOW,
+    GREEN
+}

src/main/java/com/example/trello/board/BoardController.java

@@ -0,0 +1,52 @@
+package com.example.trello.board;
+
+import com.example.trello.board.dto.*;
+import com.example.trello.config.auth.UserDetailsImpl;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/boards")
+public class BoardController {
+    private final BoardService boardService;
+
+    @PostMapping
+    public ResponseEntity<BoardResponseDto> createBoard(
+            @Valid @ModelAttribute BoardRequestDto dto,
+            @AuthenticationPrincipal UserDetailsImpl userDetails) {
+
+        BoardResponseDto boardResponseDto = boardService.createBoard(dto, userDetails.getUser().getId());
+        return new ResponseEntity<>(boardResponseDto, HttpStatus.CREATED);
+    }
+
+    @GetMapping
+    public ResponseEntity<List<BoardResponseDto>> viewAllBoard(@Valid @RequestBody viewAllBoardRequestDto dto, @AuthenticationPrincipal UserDetailsImpl userDetails) {
+        List<BoardResponseDto> boardResponseDtoList = boardService.viewAllBoard(dto, userDetails.getUser().getId());
+        return new ResponseEntity<>(boardResponseDtoList, HttpStatus.OK);
+    }
+
+    @GetMapping("/{boardId}")
+    public ResponseEntity<BoardDetailResponseDto> viewBoard(@PathVariable Long boardId, @AuthenticationPrincipal UserDetailsImpl userDetails) {
+        BoardDetailResponseDto boardDetailResponseDto = boardService.viewBoard(boardId, userDetails.getUser().getId());
+        return new ResponseEntity<>(boardDetailResponseDto, HttpStatus.OK);
+    }
+
+    @PatchMapping("/{boardId}")
+    public ResponseEntity<BoardResponseDto> updateBoard(@PathVariable Long boardId, @Valid @ModelAttribute UpdateBoardRequestDto dto, @AuthenticationPrincipal UserDetailsImpl userDetails) {
+        BoardResponseDto updatedBoardResponseDto = boardService.updateBoard(boardId, dto, userDetails.getUser().getId());
+        return new ResponseEntity<>(updatedBoardResponseDto, HttpStatus.OK);
+    }
+
+    @DeleteMapping("/{boardId}")
+    public ResponseEntity<String> deleteBoard(@PathVariable Long boardId, @AuthenticationPrincipal UserDetailsImpl userDetails) {
+        boardService.deleteBoard(boardId, userDetails.getUser().getId());
+        return new ResponseEntity<>("보드가 정상적으로 삭제되었습니다.", HttpStatus.OK);
+    }
+}

src/main/java/com/example/trello/board/BoardRepository.java

@@ -1,12 +1,17 @@
 package com.example.trello.board;
 
+import com.example.trello.common.exception.BoardErrorCode;
+import com.example.trello.common.exception.BoardException;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
+import java.util.List;
+
 @Repository
 public interface BoardRepository extends JpaRepository<Board, Long> {
+    List<Board> findAllByWorkspaceId(Long workspaceId);
 
     default Board findByIdOrElseThrow(Long id){
-        return findById(id).orElseThrow(()->new RuntimeException());
+        return findById(id).orElseThrow(() -> new BoardException(BoardErrorCode.CAN_NOT_FIND_BOARD_WITH_BOARD_ID));
     }
 }