Sucat Back-end Reamd.me ✅

🔍 목차

• 1. 프로젝트 소개
• 2. 프로젝트 팀원
• 3. 주요 기능
• 4. 프로젝트 프로토타입
• 5. 프로젝트 API 설계
• 6. 사용한 기술 스택
• 7. 프로젝트 아키텍쳐
• 8. ERD
• 9. 커밋 컨벤션
• 10. 기술적 이슈와 해결 과정

1. 📝 소개

Suwon University Community Project

• 프로젝트 이름: Sucat
• 프로젝트 설명: 수원대학교 친목형 커뮤니티
• 프로젝트 특징: 기존 커뮤니티 시스템에 게임을 추가해 사용자, 학과별로 게임 점수로 경쟁을 하며 유대감을 형성할 수 있습니다. 또한, 사용자들은 서로 친구 관계를 만들고 채팅을 하며 친밀감을 형성할 수 있습니다.

2. 💁‍♂️ 프로젝트 팀원

Backend 팀장	Backend 팀원	Backend 팀원
박상민	정아름	김지현
자체 회원가입/로그인 친구 CURD API 1:1 채팅 API 실시간 알림 API 게임 CURD API 마이페이지 API	커뮤니티 CURD API	커뮤니티 CURD API

3. 💡 주요 기능

• 자체 회원가입/로그인:
  • 대학교 메일을 이용한 이메일 인증 과정
  • 로그아웃
  • 닉네임 중복 검사
  • 약관 동의
• 커뮤니티 서비스
  • 게시글 카테고리 분류
  • 게시글 CRUD
  • 댓글/대댓글
  • 게시물 좋아요
  • 게시물 스크랩
  • 검색
• 친구 서비스
  • 친구 요청
  • 친구 수락/취소
  • 친구 삭제
  • 친구 프로필 확인
• 채팅 서비스
  • 친구 관계인 사용자와 1:1 채팅
• 실시간 알림 서비스
  • 자신의 게시물에 댓글 작성되는 경우 알림 전송
  • 대댓글이 작성되는 경우 알림 전송
  • 채팅 메시지가 오는 경우 알림 전송
• 게임 서비스
  • 게임 플레이
  • 점수에 따른 개인 순위, 통합 점수에 따른 학과 순위
  • 랭킹 시스템
• 마이 페이지
  • 내가 쓴 글, 스크랩한 글, 댓글 작성한 게시물 ... 확인
  • 프로필 설정 (프로필 미리보기, 프로필 수정)
  • 닉네임 변경

4. 프로토타입

5. 🗂️ APIs

작성한 API는 아래에서 확인할 수 있습니다.

👉🏻 API 바로보기

6. ⚙ 기술 스택

Back-end

Infra

- AWS EC2, RDS, S3, Route 53, ELB ...

Tools

7. 🛠️ 프로젝트 아키텍쳐

8. ERD

9. 커밋 컨벤션

기본 구조

type: subject

body

type 종류

feat: 새로운 기능을 추가할 경우
fix: 버그를 고친 경우
refactor: 프로덕션 코드 리팩토링의 경우
comment: 필요한 주석 추가 및 수정의 경우
docs: 문서를 수정한 경우
test: 테스트 추가, 테스트 리팩토링의 경우
chore: 빌드 태스트 업데이트, 패키지 매니저를 설정한 경우
rename: 파일 혹은 폴더명을 수정하거나 옮기는 경우
remove: 파일을 삭제하는 경우
style: 코드 포맷 변경, 코드 수정이 없는 경우
!BREAKING CHANGE!: 커다란 API 변경의 경우

커밋 예시

== ex1
feat: 로그인 기능 구현

Email 중복확인 api 개발

== ex2
fix: 사용자 정보 누락 버그 해결

사용자 서비스 코드 수정

10. 🤔 기술적 이슈와 해결 과정

• JWT Token 인증 문제
  • 💥 [Error] JWT Token 인증 문제
• 닉네임 중복 검사 기능 구현 중 발생한 문제
  • 💥 아! Get 요청시에는 Message body를 사용하면 안되는구나!!
• Circular Dependency 문제
  • [시행착오] 빈 간의 순환 참조(Circular Dependency) 문제
• 회원과 채팅방의 연관관계 문제
  • [시행착오] 회원과 채팅방의 연관관계는 N:M일까? 1:N일까?
• AWS로 배포하기
  • [시행착오] AWS 프리티어 비용 과금 이슈, 해결 방법