🙏🏻 소프트웨어 공학 IIIE 백엔드 README

• Deployment URL : 미정
• Language : Java 17
• Library & Framework : Spring Boot 3.3.2, Gradle
• Database : MySQL
• Deploy: AWS (EC2, S3, RDS), Nginx

🛠 프로젝트 아키텍쳐

추후 업로드

✨ 프로젝트 시작 방법

• git clone 후 InteliJ가 있다는 가정 하에 서술합니다.
• 프로젝트 내 /resources 위치에 [노션] > [서버]에 공유된 application.yml 파일을 넣어주세요.

// Gradle 빌드 (의존성 설치)
./gradlew build

// 빌드파일 실행
java -jar ./build/lib/...jar

📌 Commit Convention (커밋 메시지 규칙)

📌 한 커밋에는 한가지 이슈만 담을 것
📌 가능한 본문을 포함할 것.

TYPE	Subject	Des.
feat	새로운 기능을 추가하는 경우	브랜치 첫 커밋이나 기능 추가시
fix	코드를 수정하는 경우	버그 및 코드 수정의 모든 과정
docs	문서만을 수정하는 경우	주석 수정도 포함 해 주세요
refactor	버그 수정 or 기능 추가가 없는 코드 변경	리팩토링하는 과정
test	테스트 추가 과정	누락된 테스트 추가 또는 기존 테스트 수정

CLI에서 커밋 메시지 여러 줄로 작성하는 방법 (2번째 줄 부터 본문)

✅ 쌍따옴표(")를 닫지 말고 개행(엔터)하며 작성하면 됩니다.

👤 팀원 구성

임주혁	박상은

🚩 브랜치 전략

• Git-Flow 전략을 기반으로 합니다.
• main, release, develop 브랜치를 메인으로 가져갑니다.
• feature 브랜치를 보조 브랜치로 가져갑니다.
  • main 브랜치는 배포 단계에서 사용됩니다.
  • release 브랜치는 배포 직전 QA 단계에서 사용됩니다.
  • develop 브랜치는 개발 단계의 Git-flow에서 main 역할을 수행합니다.
  • feature 브랜치는 기능 단위로 사용하고 merge 후 각 브랜치를 삭제합니다.
• PR 종료는 최소 1명 이상의 리뷰어가 승인 한 경우에만 가능하도록 합니다.

💿 환경 설정

• DB 연결 또는 AWS 계정 관련 민감한 정보는 Git에 올리면 안됩니다.
• resource 아래 application 파일이 add 되지 않도록 조심해주세요.
  -> ignore가 되어있지만 그래도 혹시 모르니...

실수로 민감한 데이터가 올라간 경우

• 먼저 팀 채팅방에 내용 전파부터 해 주세요.
• Git-Filter를 이용해서 지워주시면 됩니다.
• 구문 : git filter-branch -f --index-filter "git rm --cached --ignore-unmatch <경로>/<파일명>" --prune-empty -- --all
• 그 다음 git push --force --all 로 업데이트 해 주세요.