🧇 Waffle5gram

목차

1. 프로젝트 소개
2. 배포 링크
3. 팀원 구성
4. 프로젝트 뷰
5. 사용 기술
6. 서버 구성도
7. ERD
8. 사용한 컨벤션

---

프로젝트 소개

• 2023 와플스튜디오 Rookies 세미나에서 학습한 내용을 토대로 널리 사용되는 SNS인 인스타그램 서비스를 클론 코딩하는 프로젝트의 API 서버입니다.
• 프로젝트 기간과 목적을 고려하여 다음과 같은 필수 스펙을 우선적으로 구현하였습니다.
• 회원가입 / 로그인 / 소셜 로그인
• 유저 계정 페이지
• 글 작성 / 댓글 작성
• 페이지네이션
• AWS 배포
• HTTPS 설정
• GITHUB Actions CI/CD
• 또한 기존에 없던 새로운 기능으로 검색 파트에서 인물 검색과 게시물 검색을 분리, 카테고리를 바탕으로 피드를 생성해주는 탭을 추가하였습니다.
• 이외에 조금 더 비슷한 구현을 위해 좋아요 기능, 게시물 저장 기능, 피드 기능, 팔로우 기능, 검색 기능을 추가하였습니다.

팀원 구성

	이희승(Leader)	이수혁	조성해	김지원
GitHub

배포 링크

• 배포링크 : https://api.waffle5gram.com

프로젝트 뷰

• 로그인, 홈 피드

• 카테고리별 탐색, 인물 검색

• 게시물 업로드, 사용자 프로필

사용 기술

서버 구성도

ERD

사용한 컨벤션

Code Convention

• 팀원 간 코드 스타일을 맞추고 가독성을 높여 코드 리뷰를 원활하게 하기 위해 ktlint를 사용하였습니다.
• 제일 많이 쓰이는 jlleitschuh/ktlint-gradle을 사용하였습니다.
• Github Action 을 이용하여 main 브랜치에 PR 올릴때마다 자동으로 스타일 검사를 하도록 설정하였습니다.

Commit Convention

• 아래와 같은 커밋 컨벤션을 통해 서로의 작업물이 어떤 유형의 것인지 파악하기 쉽도록 하였습니다.

Git Branch & merge 전략

• 토이 프로젝트의 성격을 고려하여 간단한 Branching 전략인 Github-flow를 사용했습니다.
• 또한, main 브랜치의 중요도를 고려하여 깔끔한 history를 위해 Squash Merge를 사용했습니다.