golden-hamster/trello

Trello Clone Project

👨‍👩‍👧‍👦 Hello Introduce US

유현식	정이삭	장기현	여준서	양혜민
@20240729	@golden-hamster	@EtherXion	@duwnstj	@asitwas729
WorkSpace, Board	CI/CD, Auth	Comment	List	Card

💜 Let's Go Our GitHub

📝 Technologies & Tools 📝

⭐ Github Rules

⭐ Code Convention

프로젝트 기능

🐇 Auth

• 이메일 형식의 아이디와 비밀번호로 회원가입
• 비밀번호 암호화 저장
• 동일한 이메일로 중복 가입 방지
• 탈퇴한 유저의 아이디(즉, 이메일) 재사용 방지

🍀 WorkSpace, Board

• 회원가입시 부여받은 ADMIN권한으로만 생성 가능
• 수정 권한이 있는 사용자(Read_Only 제외)는 멤버 초대 가능
• 수정 권한이 있는 사용자(Read_Only 제외)만이 수정 가능
• 권한(WorkSpace, Board, Read_Only)

⛓️ WorkSpace invite User

• 하나의 유저를 여러 사용자가 동시에 초대하는 경우 케이스 동시성 제어
• 낙관적 락(예상 사용 빈도와 동시성 문제 발생 가능성 낮음)
• 예외 발생시, 10회 시도 후 예외 메세지 반환

📚 List

• Board내에서 List 순서 변경 가능
• 수정 권한이 있는 사용자(Read_Only 제외)만이 수정 가능
• List 삭제 시, 연관된 Card도 모두 삭제됨

🔍 Card Search

• JOIN FETCH를 사용하여 N+1문제 해결
• INDEX를 활용하여 검색 기능 최적화 완료
• Card의 제목, 설명, 마감일, 담당자로 검색가능

🔥 Comment

• 수정 권한이 있는 사용자(Read_Only 제외)만이 댓글 생성 가능
• 카드와 댓글, 사용자 아이디가 모두 일치할 경우, 댓글 변경 가능

📁 Attached File

• AWS S3로 첨부파일 관리
• 수정 권한이 있는 사용자(Read_Only 제외)만이 첨부파일 업로드및 삭제 가능
• UUID로 첨부파일명 저장

🛎️ Alerts

• SLACK의 WEBHOOK API 사용
• JoinPoint(AOP)로 확장성 가짐

🚨 Trouble Shooting

✨ 리스트 순서 변경 개선사항

✨ IntelliJ import 오류

✨ 첨부파일 구현시 S3와 연결 오류

✨ 단건 조회시 예외처리 불명확

✨ 여러 사용자가 동일한 카드를 수정할때, 동시성 문제

✨ 카드 검색 속도 저하

🌐 Architecture

📋 ERD Diagram

🚨 프로젝트 구조

│  README.md
│  .gitignore
│  appspec.yml
│  build.gradle
│  Dockerfile
│  gradlew
│  gradlew.bat
│  settings.gradle
│
│
└─src
    ├─main
    │  ├─java
    │  │  └─com
    │  │      └─sparta
    │  │          └─trellocopy
    │  │              │  TrellocopyApplication.java
    │  │              │
    │  │              ├─config
    │  │              │      JwtAuthenticationToken.java
    │  │              │      JwtSecurityFilter.java
    │  │              │      JwtUtil.java
    │  │              │      PersistenceConfig.java
    │  │              │      S3Config.java
    │  │              │      SecurityConfig.java
    │  │              │
    │  │              └─domain
    │  │                  ├─board
    │  │                  │  ├─controller
    │  │                  │  │      BoardController.java
    │  │                  │  │
    │  │                  │  ├─dto
    │  │                  │  │      BoardRequest.java
    │  │                  │  │      BoardResponse.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      Board.java
    │  │                  │  │
    │  │                  │  ├─exception
    │  │                  │  │      BoardNotFoundException.java
    │  │                  │  │
    │  │                  │  ├─repository
    │  │                  │  │      BoardRepository.java
    │  │                  │  │
    │  │                  │  └─service
    │  │                  │          BoardService.java
    │  │                  │
    │  │                  ├─card
    │  │                  │  ├─controller
    │  │                  │  │      CardController.java
    │  │                  │  │
    │  │                  │  ├─dto
    │  │                  │  │  ├─req
    │  │                  │  │  │      AddCardUserRequest.java
    │  │                  │  │  │      CardSaveRequest.java
    │  │                  │  │  │      CardSearchRequest.java
    │  │                  │  │  │      CardSimpleRequest.java
    │  │                  │  │  │
    │  │                  │  │  └─res
    │  │                  │  │          CardDetailResponse.java
    │  │                  │  │          CardSimpleResponse.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      Card.java
    │  │                  │  │
    │  │                  │  ├─exception
    │  │                  │  │      CardForbiddenException.java
    │  │                  │  │      CardNotFoundException.java
    │  │                  │  │
    │  │                  │  ├─repository
    │  │                  │  │      CardRepository.java
    │  │                  │  │
    │  │                  │  └─service
    │  │                  │          CardService.java
    │  │                  │
    │  │                  ├─comment
    │  │                  │  ├─Controller
    │  │                  │  │      CommentController.java
    │  │                  │  │
    │  │                  │  ├─Dto
    │  │                  │  │      CommentRequestDto.java
    │  │                  │  │      CommentResponseDto.java
    │  │                  │  │      CommentSaveRequestDto.java
    │  │                  │  │      CommentSaveResponseDto.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      Comment.java
    │  │                  │  │
    │  │                  │  ├─repository
    │  │                  │  │      CommentRepository.java
    │  │                  │  │
    │  │                  │  └─Service
    │  │                  │          CommentService.java
    │  │                  │
    │  │                  ├─common
    │  │                  │  ├─aop
    │  │                  │  │      Alarm.java
    │  │                  │  │      AlarmAspect.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      Timestamped.java
    │  │                  │  │
    │  │                  │  └─exception
    │  │                  │          BadRequestException.java
    │  │                  │          ForbiddenException.java
    │  │                  │          NotFoundException.java
    │  │                  │          UnauthorizedException.java
    │  │                  │
    │  │                  ├─file
    │  │                  │  ├─controller
    │  │                  │  │      FileController.java
    │  │                  │  │
    │  │                  │  ├─dto
    │  │                  │  │      FileDto.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      File.java
    │  │                  │  │
    │  │                  │  ├─repository
    │  │                  │  │      FileRepository.java
    │  │                  │  │
    │  │                  │  └─service
    │  │                  │          FileService.java
    │  │                  │
    │  │                  ├─list
    │  │                  │  ├─controller
    │  │                  │  │      ListController.java
    │  │                  │  │
    │  │                  │  ├─dto
    │  │                  │  │  ├─request
    │  │                  │  │  │      ListSaveRequest.java
    │  │                  │  │  │      ListUpdateRequest.java
    │  │                  │  │  │
    │  │                  │  │  └─response
    │  │                  │  │          ListSaveResponse.java
    │  │                  │  │          ListUpdateResponse.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      Lists.java
    │  │                  │  │
    │  │                  │  ├─exception
    │  │                  │  │      ListNotFoundException.java
    │  │                  │  │      ListNotInWorkSpaceException.java
    │  │                  │  │
    │  │                  │  ├─repository
    │  │                  │  │      ListRepository.java
    │  │                  │  │
    │  │                  │  └─service
    │  │                  │          ListService.java
    │  │                  │
    │  │                  ├─user
    │  │                  │  ├─controller
    │  │                  │  │      AuthController.java
    │  │                  │  │      UserController.java
    │  │                  │  │
    │  │                  │  ├─dto
    │  │                  │  │  │  AuthUser.java
    │  │                  │  │  │
    │  │                  │  │  ├─request
    │  │                  │  │  │      GrantRequest.java
    │  │                  │  │  │      LoginRequest.java
    │  │                  │  │  │      UserJoinRequest.java
    │  │                  │  │  │      WithdrawRequest.java
    │  │                  │  │  │
    │  │                  │  │  └─response
    │  │                  │  │          LoginResponse.java
    │  │                  │  │          UserJoinResponse.java
    │  │                  │  │          UserResponse.java
    │  │                  │  │          WorkspaceUserResponse.java
    │  │                  │  │
    │  │                  │  ├─entity
    │  │                  │  │      CardUser.java
    │  │                  │  │      User.java
    │  │                  │  │      UserRole.java
    │  │                  │  │      WorkspaceRole.java
    │  │                  │  │      WorkspaceUser.java
    │  │                  │  │
    │  │                  │  ├─exception
    │  │                  │  │      CardUserAlreadyExistsException.java
    │  │                  │  │      CardUserNotFoundException.java
    │  │                  │  │      DuplicateUserException.java
    │  │                  │  │      InvalidPasswordException.java
    │  │                  │  │      UserNotFoundException.java
    │  │                  │  │      WithdrawnUserException.java
    │  │                  │  │      WorkspaceRoleForbiddenException.java
    │  │                  │  │      WorkspaceUserNotFoundException.java
    │  │                  │  │
    │  │                  │  ├─repository
    │  │                  │  │      CardUserRepository.java
    │  │                  │  │      UserRepository.java
    │  │                  │  │      WorkspaceUserRepository.java
    │  │                  │  │
    │  │                  │  └─service
    │  │                  │          AuthService.java
    │  │                  │          UserService.java
    │  │                  │
    │  │                  └─workspace
    │  │                      ├─controller
    │  │                      │      WorkspaceController.java
    │  │                      │
    │  │                      ├─dto
    │  │                      │      WorkspaceRequest.java
    │  │                      │      WorkspaceResponse.java
    │  │                      │
    │  │                      ├─entity
    │  │                      │      Workspace.java
    │  │                      │
    │  │                      ├─exception
    │  │                      │      WorkspaceForbiddenException.java
    │  │                      │      WorkspaceNotFoundException.java
    │  │                      │
    │  │                      ├─repository
    │  │                      │      WorkspaceRepository.java
    │  │                      │
    │  │                      └─service
    │  │                              WorkspaceService.java
    │  │
    │  └─resources
    │      └─db
    │          └─migration
    │                  V1__init.sql
    │                  V2__add_file.sql
    │                  V3__add_timestamp_columns.sql
    │
    └─test
        └─java
            └─com
                └─sparta
                    └─trellocopy
                        │  TrellocopyApplicationTests.java
                        │
                        ├─comment
                        │      CommentServiceTest.java
                        │
                        └─domain
                            └─card
                                ├─controller
                                │      CardControllerTest.java
                                │
                                └─service
                                        CardServiceTest.java
                                        CardServiceWithLockTest.java