📌 프로젝트 소개는 추후 기획 확정 후 업데이트할 예정입니다.
| 채윤지 (팀장) | 김준혁 | 오채현 | 최유성 | 이운학 |
|---|---|---|---|---|
 |
 |
 |
 |
 |
| @KateteDeveloper | @ddo0122 | @ochyeon | @yousung1020 | @dldnsgkr |
| 추후 업데이트 예정 | 추후 업데이트 예정 | 추후 업데이트 예정 | 추후 업데이트 예정 | 추후 업데이트 예정 |
담당 업무는 기능별 작업 분배가 확정되는 대로 업데이트합니다.
-
Backend
- Java 21
- Spring Boot 4.1.0
- Gradle 9.5.1
-
Database
- MySQL (mysql-connector-j)
- Spring Data JPA / Hibernate ORM
- QueryDSL (io.github.openfeign.querydsl 7.0)
-
캐싱
- Redis (spring-boot-starter-data-redis)
-
보안 및 인증
- Spring Security
- JWT (jjwt 0.12.x)
-
API 문서화
- Swagger (springdoc-openapi-starter-webmvc-ui 3.0.1)
-
주요 라이브러리
- Lombok
mac/Windows 모두 동일하게 동작합니다. clone 후 최초 1회
task setup을 꼭 실행하세요.
| 도구 | 용도 | macOS | Windows |
|---|---|---|---|
| JDK 21 | 빌드/실행 (Gradle toolchain이 자동 인식) | brew install temurin@21 |
Adoptium 설치 |
| Task | 태스크 러너 | brew install go-task/tap/go-task |
winget install Task.Task |
| pre-commit | 커밋 전 검사 훅 | brew install pre-commit |
pip install pre-commit |
| Docker | MySQL·Redis 로컬 실행 | Docker Desktop 설치 | Docker Desktop 설치 |
git clone <repo-url>
cd Li-routi_Backend
task setup # pre-commit git 훅 설치 (커밋 시 자동 검사 활성화)
task docker-up # MySQL·Redis 컨테이너 기동
gradle-wrapper.jar가 없어./gradlew실행이 실패하면task wrapper로 생성할 수 있습니다.
MySQL·Redis 는 docker-compose.yml 로 로컬에서 띄웁니다. 접속 정보는 application.yaml 의 기본값(localhost:3306, DB lirouti)을 그대로 사용하므로 별도 설정 없이 바로 동작합니다.
task docker-up # 컨테이너 기동 (백그라운드)
task docker-down # 중지 (데이터 유지)
task docker-reset # 컨테이너 + 볼륨(데이터) 완전 삭제
task docker-logs # 로그 확인애플리케이션은 Spring 프로파일로 설정을 관리합니다.
application.yaml— 공통/기본값(로컬 개발 기준,active: local)application-local.yaml— 개인 로컬 오버라이드 (git 미추적). 필요할 때만 만들면 됩니다.
로컬에 이미 MySQL(3306)이 떠 있어 포트를 바꿔야 하는 경우 두 파일만 추가하면 됩니다 (둘 다 git 미추적):
docker-compose.override.yml— 컨테이너 노출 포트 변경services: mysql: ports: !override - "3307:3306"
src/main/resources/application-local.yaml— 앱 접속 포트 변경spring: datasource: url: jdbc:mysql://localhost:3307/lirouti?serverTimezone=Asia/Seoul&characterEncoding=UTF-8&allowPublicKeyRetrieval=true&useSSL=false
task # 사용 가능한 태스크 목록
task build # 전체 빌드 (컴파일 + 테스트) ※ docker-up 선행 필요
task test # 테스트
task run # 앱 실행 (MySQL·Redis 필요)
task check # 커밋/PR 전 검증 (pre-commit + build)task setup 이후 git commit 하면 훅이 자동 실행되어 줄 끝 공백·개행 정리, 줄바꿈(LF) 통일, Java 컴파일 등을 검사합니다.
- 훅이 파일을 자동 수정하면 커밋이 한 번 중단됩니다. 수정된 파일을
git add후 다시 커밋하세요. - 커밋 전 미리 확인:
task precommit
⚠️ 새로 clone한 팀원이task setup을 실행하지 않으면 훅이 없어 자동 검사가 동작하지 않습니다.
도메인 주도(Domain-Driven) 패키지 구조를 따릅니다.
lirouti/
└── src/
├── main/
│ ├── java/com/lirouti/
│ │ ├── domain/
│ │ │ ├── auth/
│ │ │ ├── member/
│ │ │ ├── home/
│ │ │ ├── housework/
│ │ │ ├── consumable/
│ │ │ ├── shop/
│ │ │ ├── order/
│ │ │ ├── notification/
│ │ │ └── onboarding/
│ │ │ ├── controller/ # API 엔드포인트
│ │ │ ├── converter/ # Entity <-> DTO 변환
│ │ │ ├── dto/ # request / response
│ │ │ ├── entity/ # JPA 엔티티
│ │ │ ├── exception/ # 도메인별 예외, 에러/성공 코드
│ │ │ ├── repository/ # 데이터 접근 계층
│ │ │ └── service/ # 비즈니스 로직 (command / query)
│ │ └── global/
│ │ ├── apiPayload/ # 공통 응답, 예외 처리
│ │ ├── auth/ # 인증 필터
│ │ ├── config/ # 설정
│ │ ├── entity/ # 공통 엔티티(BaseEntity 등)
│ │ ├── properties/ # 설정 프로퍼티
│ │ └── util/ # 유틸리티
│ └── resources/
│ └── application.yaml
└── test/
└── java/com/lirouti/
| 브랜치 | 설명 |
|---|---|
main |
실제 배포용 브랜치 |
develop |
개발 통합 브랜치 |
feat/#이슈번호-기능요약 |
새로운 기능 개발 시 |
hotfix/#이슈번호-기능요약 |
긴급 버그 수정 시 |
refactor/#이슈번호-리팩토링요약 |
리팩토링 시 |
💡 브랜치명 형식:
타입/#이슈번호-기능요약
✅ 예시
feat/#12-kakao-login
타입: 주제
본문(선택)
| 타입 | 설명 | 예시 |
|---|---|---|
feat |
새로운 기능 추가 | feat: add social login |
fix |
버그 수정 | fix: resolve token expiry bug |
hotfix |
운영 중 긴급 버그 수정 | hotfix: patch payment crash |
refactor |
기능 변경 없는 코드 구조 개선 | refactor: extract auth service |
perf |
성능 개선 | perf: optimize query indexing |
style |
코드 포맷팅, 세미콜론 등 (동작 변화 없음) | style: apply prettier |
design |
UI/CSS 등 디자인 변경 | design: update button styles |
docs |
문서 수정 (README, 주석 등) | docs: update API guide |
comment |
주석 추가/변경 | comment: add function docs |
test |
테스트 코드 추가/수정 | test: add login unit tests |
build |
빌드 시스템, 의존성 변경 | build: bump next to 14.2 |
ci |
CI 설정 변경 (GitHub Actions 등) | ci: fix OOM in build step |
chore |
기타 잡일 (설정, 패키지 등) | chore: update gitignore |
rename |
파일/폴더명 변경 | rename: move utils to lib |
remove |
파일 삭제 | remove: delete legacy api |
revert |
이전 커밋 되돌리기 | revert: feat add social login |
✅ 예시
feat: 카카오 소셜 로그인 관련 jwt 발행 완료
main브랜치에 직접 push 금지- merge 전 빌드/테스트 진행해보기
- PR 템플릿에 타이트하게 맞추지 않고 유동적으로 작성하되, 의미가 명확하게 전달되도록 작성
리뷰 코멘트 작성 시 우선순위 태그를 붙여서 작성합니다.
| 태그 | 의미 | 설명 |
|---|---|---|
[P1] |
필수 수정 | merge 전 반드시 반영해야 하는 사항 (버그, 로직 오류, 보안 이슈 등) |
[P2] |
권장 수정 | 반영하면 좋지만 필수는 아닌 사항 (가독성, 컨벤션, 구조 개선 등) |
[P3] |
제안/의견 | 사소한 의견, nit, 선택 사항 |
✅ 예시
[P1] 여기서 null 체크가 빠져 있어서 NPE 발생 가능성이 있습니다.[P2] 이 로직은 Service 레이어로 옮기는 게 더 적절해 보여요.[P3] 변수명을 조금 더 명확하게 하면 어떨까요? (nit)
모든 API 응답은 ApiResponse<T>로 감싸서 반환합니다.
{
"isSuccess": true,
"code": "COMMON200",
"message": "string",
"result": {}
}isSuccess: 성공 여부code: 도메인별 비즈니스 코드 (예:COMMON400_1,AUTH403_1)message: 프론트엔드 쪽에서 참고할 메시지result: 실제 응답 데이터. 실패 시에는 보통null반환
- 모든 예외는
GeneralExceptionAdvice(@RestControllerAdvice) 기반의 전역 예외 처리 클래스에서 처리 - 컨트롤러/서비스에서는 예외를 직접 잡지 않고,
GeneralException에 에러 코드를 실어 throw 하는 방식으로 통일 - 예외 상태는
BaseErrorCode를 구현한 ENUM 클래스로 관리 (UMC 워크북과 비슷한 방식)- 공통 에러:
GeneralErrorCode - 도메인별 에러: 각
domain/{도메인}/exception/code/error패키지에 정의
- 공통 에러:
© 2026 LiRouti Team. All rights reserved.
This project and its source code are proprietary and confidential. Unauthorized copying, modification, distribution, or use of this software is strictly prohibited.