개발 환경 세팅

개요

신규 개발자를 위해 개발 환경 세팅 방법을 정리한 글입니다.
⚠️ 아래 내용을 따라하다 안되거나, 모르는 부분이 있으면 빠르게 도움을 요청합시다 ⚠️

개발 환경

• 언어: Java 17
• 데이터베이스: MySQL, Redis
• API 문서: Bruno

로컬 환경 설정

1. solid-connect-server 레포지토리의 main 브랜치 코드를 클론한다.
2. run configuration에서 active profile을 dev로 설정한다.
   

서브모듈 설정

1. 루트 경로에서 git submodule update --remote 명령어를 통해 서브 모듈을 불러온다.
2. src/main/resources 경로에 secret 폴더와 하위의 파일들이 생기면 성공이다.
   

로컬에서 실행

1. 루트 경로에서 docker-compose -f docker-compose.local.yml up -d 명령어를 통해 mysql과 redis를 실행한다.
2. 어플리케이션을 실행하여 아래 메세지가 보이면 성공이다.
   

API 문서

1. bruno를 다운받는다.
2. api-docs 레포지토리의 main 브랜치 코드를 클론한다.
3. bruno를 열고, 'Open Collection'을 눌러 클론한 코드를 불러온다.
   
4. 아래와 같이 불러와지면 성공이다.
   

API 문서 번경 사항 적용 방법

사실 기본적으로 자바 코드에 변경사항이 있을 때 PR하는 방법과 동일한데, bruno는 git UI를 사용하려면 유료 결제를 해야한다.. 💸
git UI 없이 작업하실 개발자분들을 위해 튜토리얼을 작성해본다.

• api-docs 레포지토리를 로컬에 클론했다고 가정한다.
• git CLI를 기준으로 작성했지만, 다른 git 툴로도 동일하게 동작한다.

0. 최신 내용 반영

# 원격 저장소 확인 : api-docs 레포지토리 주소가 등록되어있어야 함
git remote -v

# 최신 내용 반영
git fetch origin
git pull origin

1. 새로운 브랜치 생성, 체크아웃

# git checkout -b 는 새로운 브랜치를 생성하고, 전환하는 명령어
git checkout -b {새로운 브랜치 이름}

2. api 수정

bruno에서 수정해도 되고, bruno 코드 자체를 수정해도 된다. 개인적으로 bruno에서 수정하는게 실수를 더 적게 한다 생각해서 이 방법을 추천한다..

3. 커밋

git commit -m "커밋 메세지"

4. 푸쉬

git push {원격저장소 이름} {브랜치 이름}