TokBaro Backend

TokBaro(똑바로) 웹 백엔드 API 서버

• Framework: Spring Boot 3.5 / Java 21
• Database: MySQL
• 인증: JWT (RS512)
• 문서: Swagger UI (/swagger-ui.html)

---

실행 방법

# 빌드
./gradlew build

# 로컬 실행 (application-local.properties 필요)
./gradlew bootRun --args='--spring.profiles.active=local'

src/main/resources/application-local.properties에 DB, JWT, S3 등 로컬 설정을 작성해야 합니다.

---

Git Convention

브랜치 네이밍

main                              # 배포 브랜치
feat/기능명                        # 기능 개발
fix/버그명                         # 버그 수정
refactor/대상                      # 리팩토링
chore/작업명                       # 설정/기타

• 소문자 영어, 단어 구분은 -(하이픈)
• 도메인명 포함하여 명확하게 작성

feat/certificate-issuance
feat/laborContract-hashSecurity
feat/certificateIssuance-QR

커밋 메시지

type(scope): 설명

타입	설명
feat	새로운 기능
fix	버그 수정
refactor	코드 개선
chore	설정, 빌드 등
test	테스트 코드
delete	파일/코드 삭제
docs	문서 변경

• 설명은 한국어로 작성
• scope는 도메인명 (선택): contract, education, company, security 등
• 여러 도메인은 쉼표로 구분: feat(company, education): ...

feat(contract): 계약서 서명 API 구현
fix: 직원 전용 API 권한 필터 충돌 해결
refactor(pdf): PDF 렌더링 공통 서비스 추출
test(contract): 암호화 서비스 단위 테스트 추가

상세 내용이 필요한 경우:

feat(contract): 직원 전용 계약서 조회 쿼리 추가
- LaborContractRepository에 findSentContractsByEmployeeId 추가
- DRAFT 상태 문서 직원 열람 차단 조건 적용

Pull Request

• feat/기능명 → main으로 PR 생성
• PR 템플릿 (자동 적용):
  • 📌 작업 개요
  • 📝 작업 내용 (체크리스트)
  • 📎 참고 사항
  • 🖼️ 스크린샷

작업 흐름

1. main에서 브랜치 생성     git checkout -b feat/기능명
2. 작업 후 커밋             git commit -m "feat(scope): 설명"
3. push                    git push origin feat/기능명
4. GitHub에서 PR 생성       main ← feat/기능명
5. 리뷰 후 merge

.gitignore 주의

파일	이유
application-local.properties	로컬 DB 비밀번호 등 개인 설정
src/main/resources/crypto/**	RSA 키 파일
.idea/, build/	IDE 설정, 빌드 산출물