SOPT 메이커스 운영 프로덕트 서버

updated at 2024.08.12

SOPT 활동 기수 회원들의 편리한 활동과
SOPT 임원진의 원활한 운영을 돕는 프로덕트를 만들고

SOPT makers 프로덕트들이 전역적으로 사용하는 internal API를 관리합니다.

핵심 기능

웹 어드민 (임원진 대상)

• 세미나, 행사 등 세션 생성
• 활동 기수 회원의 출석 내역 관리
• 푸시 알림을 전송할 공지 및 소식 작성, 푸시알림 전송

출석 앱 (활동 기수 회원 대상)

• 참여한 세션 출석 체크, 자신의 출석 내역 조회

인증 및 로그인 / 회원 데이터 관리 (전 프로덕트 대상)

• SSO(Single Sign-On)와 유사한 방식의 공통 토큰 발급
• 유저 고유 데이터 및 개인정보를 중앙화하여 표준화된 유저 API 제공

Server Acrchitecture

Used Stacks

Process

1. 개발 전에 github issue를 생성해주세요!
   1. 템플릿에 맞게 내용을 작성한다
   2. Assignees, Label을 단다
   3. label의 경우 타입과 본인의 이름을 할당한다 (chore yongtaek)
2. feature branch를 생성해주세요!
   1. 브랜치명은 {이슈 종류}/#{이슈번호}_T-{티켓번호} 로 한다
   2. 예시는 다음과 같다 브랜치명: feat/#123_T-4567
3. 로컬에서 작업하고 기능단위로 쪼개서 커밋을 해주세요!
4. 해당 issue에 대한 작업이 완료되었다면 github에 해당 브랜치를 올려주세요!
5. PR을 템플릿에 맞춰서 올려주세요!
6. 리뷰어가 approve할 때까지 기능을 수정하면서 개발해주세요!
7. approve가 완료되었다면 merge를 진행해주세!요

코드 외적인 부분(환경변수, db 필드 및 테이블 수정, 인프라 세팅 등) 수정사항이 있다면 팀원에게 먼저 물어보고 진행하거나, 그러지 못하였더라면 빠르게 전달해주세요!(카톡, 슬랙, 디코 등)

Commit Convention

태그 이름	설명
[CHORE]	코드 수정, 내부 파일 수정
[FEAT]	새로운 기능 구현
[ADD]	FEAT 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성
[HOTFIX]	issue나 QA에서 급한 버그 수정에 사용
[FIX]	버그, 오류 해결
[DEL]	쓸모 없는 코드 삭제
[DOCS]	README나 WIKI 등의 문서 개정
[CORRECT]	주로 문법의 오류나 타입의 변경, 이름 변경에 사용
[MOVE]	프로젝트 내 파일이나 코드의 이동
[RENAME]	파일 이름 변경이 있을 때 사용
[IMPROVE]	향상이 있을 때 사용
[REFACTOR]	전면 수정이 있을 때 사용

Branch Strategy

• main, develop, feature 브랜치가 있습니다!
• main은 production용 브랜치입니다
  • 실서비스용 ec2(**makers.operation.prod)**로 배포되도록 파이프라인이 구축되어 있습니다
• develop은 development용 브랜치입니다!
  • 테스트용 ec2(**makers.operation)**로 배포되도록 파이프라인이 구축되어 있습니다
  • default 브랜치 입니다
• feature은 {이슈 종류}/#{이슈번호}_T-{티켓번호} 로 되어있는 브랜치입니다!
  • 각자 이슈에 대한 작업물의 브랜치입니다
    • 이슈에 따라 브랜치 Prefix를 feat/fix/modify등 여러가지를 활용할 수 있습니다
  • develop에 PR을 거쳐 merge 해주세요
  • 팀 내에서 사용하고 있는 프로젝트 관리 툴 Height 의 Magic Link 활용을 위해 위와 같은 이름 형식을 가집니다.

프로젝트 폴더 구조

멀티모듈 구조

📁 operation-api # Controller, Service
📁 operation-auth # Authentication 관련 기능
📁 operation-common # 공통 기능 / 공용 객체
📁 operation-domain # Entity & Repository
📁 operation-external # 외부 API 기능(SOPT 메이커스 내 플레이그라운드, 알림 서버)

모듈 내 구조

operation-api

📁 src
|_ 📁 main
|_ |_ 📁 app # 앱 기능
|_ |_ 📁 auth # 인증 기능
|_ |_ 📁 common # 공통 기능
|_ |_ 📁 scheduler # 자동 출석 처리 기능(Spring Scheduling - Cron Job)
|_ |_ 📁 test # HealthCheck API Controller
|_ |_ 📁 user # 유저 기능
|_ |_ 📁 web # 웹 기능
|_ |_ OperationApplication.java // Spring Application Class

operation-auth

📁 src
|_ 📁 main
|_ |_ 📁 authentication // 구현체
|_ |_ 📁 config // Spring Security Config
|_ |_ 📁 filter // Filter 구현체
|_ |_ 📁 jwt // JWT 발급 관련 객체
|_ |_ AuthRoot.java // Auth Module 패키지 인식을 위한 Interface

operation-common

📁 src
|_ 📁 main
|_ |_ 📁 code // 성공 및 실패 Code 객체
|_ |_ 📁 config // 전역 환경 변수 값 주입 객체
|_ |_ 📁 dto // API 공용 Base Api Response Body 객체
|_ |_ 📁 exception // Application 도메인별 Exception 객체
|_ |_ 📁 util // API 공용 Api Response 생성 객체 
|_ |_ CommonRoot.java // Common Module 패키지 인식을 위한 Interface

operation-domain

// 공통적으로 각 도메인의 Entity 및 Repository 관리
📁 src
|_ 📁 main
|_ |_ 📁 admin
|_ |_ 📁 alarm
|_ |_ 📁 attendance
|_ |_ 📁 auth
|_ |_ 📁 common
|_ |_ 📁 lecture
|_ |_ 📁 member
|_ |_ 📁 schedule
|_ |_ 📁 user
|_ |_ DomainRoot.java // Domain Module 패키지 인식을 위한 Interface

operation-external

📁 src
|_ 📁 main
|_ |_ 📁 client // 외부 서버 or API 통신 객체 구현
|_ |_ 📁 config // 외부 통신(RestTemplate) 설정 객체
|_ |_ ExternalRoot.java // External Module 패키지 인식을 위한 Interface