/Instagram-Spring

[Numble 챌린지] 네카라쿠배 개발자와 함께 Spring으로 인스타그램 서버 만들기

Primary LanguageJava

📌 Instagram-Spring

KakaoTalk_Image_2023-04-14-02-58-53

인스타그램의 기능들을 Spring으로 구현하는 서버입니다.

Rest API 서버로 좀 더 Spring에 집중하여 구현하기 위해 클라이언트는 따로 있지않습니다.

자세한 구현 내용과 고민, 트러블 슈팅은 ISSUESPR에서 확인하실 수 있습니다.

컨벤션이나 프로젝트의 소개는 WIKI에서 확인하실 수 있습니다.

배포된 Rest API 문서를 통해 서버의 API 목록을 확인하실 수 있습니다.

  • 2023/05/28 배포가 중지되었습니다. 프로젝트의 src/main/resources/static/docs/index.html 에서 api문서를 확인하실 수 있습니다.

챌린지를 위해 만든 Repository 이기에 2023/04 이후의 업데이트는 없습니다.

📖 넘블 인스타그램 서버만들기 챌린지에서 1등을 수상했습니다.

넘블 1등 수상

📖 프로젝트 목표

  • Github Actions로 CI / CD 파이프라인을 구성해 배포 자동화한다.
  • 커밋 컨벤션과 클린코드의 규칙을 지켜서 프로젝트를 완수한다.
  • 절대 하드코딩 하지 않으며 단위테스트를 잘 작성한다.
  • 각 API의 기능들을 기능적으로 잘 동작할 수 있게 고민해서 로직을 작성한다.

📖 개발 상세 내용

📖 배포 환경

  • Java : openJDK 17
  • Spring boot 3.0.5
  • AWS EC2 micro.t2, RAM 1GB, vCPU 1, 볼륨 20GiB
  • Database : MySQL Community (AWS RDS : t3.micro) RAM 1GB, vCPU 2, 볼륨 20GiB

📖 개발 순서

  • 다음과 같이 개발 할 기능 또는 수정해야 할 사항들을 Issue에 등록합니다. 스크린샷 2023-04-13 오전 3 20 27

  • Issue에 등록 된 사항에 대해 개발을 진행하고 PR을 통해 기능이 개발됬음을 알리고 Develope 브랜치에 merge합니다.

  • 배포시에도 배포한다는 PR을 올리고 main 브랜치에 merge 합니다.

  • main 브랜치에 merge시 Github Actions로 서버에 자동 배포가 완료됩니다.

  • PR은 다음과 같이 등록합니다. 스크린샷 2023-04-13 오전 3 20 43