Skip to content

Commit d4b2668

Browse files
authored
[docs] 리드미 작성 (#183)
* docs: 리드미 초안 작성 * docs: 시스템 아키텍처 & ERD 이미지 수정 - 코스 수정: Course가 가지고있는 Member로 검증 - 코스 생성: Repository에 저장되지 않고있던 부분 수정
1 parent a8e16ea commit d4b2668

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## 프로젝트 소개
2+
[API 테스트 영상](https://www.youtube.com/watch?v=Y6SClkNVSwo)
3+
4+
## 시스템 아키텍처
5+
![System_Architecture](https://github.com/user-attachments/assets/5a41693f-e9dd-4257-b34d-8de5457b0b49)
6+
7+
## ERD
8+
![ERD](https://github.com/user-attachments/assets/9d2a2e7d-4c89-4baa-963d-eeccbfb2b7fe)
9+
10+
## 기술 스택
11+
### Backend
12+
![Java](https://img.shields.io/badge/java-007396?style=for-the-badge&logo=java&logoColor=white)
13+
![Springboot](https://img.shields.io/badge/springboot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)
14+
![JWT](https://img.shields.io/badge/jwt-000000?style=for-the-badge&logo=jsonwebtokens&logoColor=white)
15+
![MySQL](https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white)
16+
![Redis](https://img.shields.io/badge/redis-FF4438?style=for-the-badge&logo=redis&logoColor=white)
17+
![Docker](https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
18+
19+
### Tool
20+
![IntelliJ IDEA](https://img.shields.io/badge/intellijidea-000000?style=for-the-badge&logo=intellijidea&logoColor=white)
21+
![Gradle](https://img.shields.io/badge/gradle-02303A?style=for-the-badge&logo=gradle&logoColor=white)
22+
![Github](https://img.shields.io/badge/github-181717?style=for-the-badge&logo=github&logoColor=white)
23+
![Discord](https://img.shields.io/badge/discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)
24+
![Notion](https://img.shields.io/badge/notion-000000?style=for-the-badge&logo=notion&logoColor=white)
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

Comments
 (0)