|
| 1 | +## 프로젝트 소개 |
| 2 | +[API 테스트 영상](https://www.youtube.com/watch?v=Y6SClkNVSwo) |
| 3 | + |
| 4 | +## 시스템 아키텍처 |
| 5 | + |
| 6 | + |
| 7 | +## ERD |
| 8 | + |
| 9 | + |
| 10 | +## 기술 스택 |
| 11 | +### Backend |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +### Tool |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +## 컨벤션 |
| 28 | +### 브랜치 컨벤션 |
| 29 | +``` |
| 30 | +- main |
| 31 | + - 실제 배포 CI/CD용 branch |
| 32 | +- develop |
| 33 | + - 개발 CI/CD용 branch |
| 34 | +- feature |
| 35 | + - 기능 구현용 branch |
| 36 | + - 반드시 `develop`에서 뻗어나와 `develop`으로 `merge` 되어야한다. |
| 37 | +- fix |
| 38 | + - 배포 전 기능 수정용 branch |
| 39 | +- hotfix |
| 40 | + - 실제 배포 버전에서 발생한 버그 수정용 branch |
| 41 | +``` |
| 42 | +### PR 컨벤션 |
| 43 | +``` |
| 44 | +[Issue_종류] 구현_내용 #이슈_번호 |
| 45 | +
|
| 46 | +ex) [feature] 로그인 구현 #1 |
| 47 | +``` |
| 48 | +- Pull Request만 날리고, Approve는 reviewer가 한다. |
| 49 | +- `develop` branch로의 `merge`는 1명 이상의 Approve가 필요함. |
| 50 | + |
| 51 | +### 커밋 컨벤션 |
| 52 | +``` |
| 53 | +Issue_종류: 구현 내용 |
| 54 | +
|
| 55 | +ex) feat: 로그인 구현 |
| 56 | +``` |
| 57 | +- Pull Request만 날리고, Approve는 reviewer가 한다. |
| 58 | +- `develop` branch로의 `merge`는 1명 이상의 Approve가 필요함. |
| 59 | + |
| 60 | +### 패키지 컨벤션 |
| 61 | +- Domain Driven Design(도메인 주도 설계) |
| 62 | +``` |
| 63 | +- domain : 애플리케이션의 비지니스 로직을 포함 |
| 64 | + - entity |
| 65 | + - api: 외부와의 요청을 처리(Controller) |
| 66 | + - dao: 데이터베이스와의 상호작용(Repository) |
| 67 | + - domain: 엔티티 객체 |
| 68 | + - dto: 데이터 전송 객체(DTO) |
| 69 | + - service: 비지니스 로직 처리(Service) |
| 70 | + - converter: entity ↔ dto 변환 |
| 71 | +- global: 애플리케이션 전반에서 사용할 수 있는 공통 코드를 포함 |
| 72 | +- infra: 외부 시스템과 연동되는 코드를 포함 |
| 73 | +``` |
0 commit comments