Skip to content

Commit 4730adb

Browse files
committed
DOCS: 변경 내용 문서 수정
1 parent 8c0b0c7 commit 4730adb

File tree

3 files changed

+54
-52
lines changed

3 files changed

+54
-52
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,25 @@
22

33
![프로젝트이미지](https://github.com/user-attachments/assets/6e0bdf74-a374-4c70-952d-fc22e0ba3413)
44

5+
### 버전 및 개발 기간
6+
* v1.0.0: 2024/11/18 ~ 2024/12/09
7+
* v1.1.0: 2024/12/19 ~ 2024/12/31
8+
* v2.0.0: 2025/01/01 ~ (예정)
9+
10+
<br>
11+
512
## 🍀 프로젝트 소개
6-
아이주주는 초등학생들이 돈과 투자의 기본 개념을 쉽고 재미있게 배울 수 있도록 설계된 모의투자 학습 플랫폼입니다.
13+
아이주주는 초등학생들이 돈과 투자의 기본 개념을 쉽고 재미있게 배울 수 있도록 설계된
14+
모의투자 학습 플랫폼입니다.
715

816
[🔗 기획서](https://www.notion.so/13f336d06fda80d4a0dfc9e9ac30e96b?pvs=4)
9-
[🔗 디자인](https://www.figma.com/design/HfCXjOdS1CcDWLJbhci0dI/%EC%95%84%EC%9D%B4%EC%A3%BC%EC%A3%BC-%EC%99%80%EC%9D%B4%EC%96%B4%ED%94%84%EB%A0%88%EC%9E%84?node-id=0-1&t=WB1ZEVppjZTp8DY5-1)
17+
[🔗 와이어프레임](https://www.figma.com/design/HfCXjOdS1CcDWLJbhci0dI/%EC%95%84%EC%9D%B4%EC%A3%BC%EC%A3%BC-%EC%99%80%EC%9D%B4%EC%96%B4%ED%94%84%EB%A0%88%EC%9E%84?node-id=0-1&t=WB1ZEVppjZTp8DY5-1)
1018
[🔗 프론트 깃허브](https://github.com/prgrms-web-devcourse-final-project/WEB1_2_Child-Learn_FE)
1119
[🔗 백엔드 깃허브](https://github.com/prgrms-web-devcourse-final-project/WEB1_2_Child-Learn_BE)
1220
[🔗 아이주주 바로가기](http://ijuju.site)
1321

14-
### 개발기간 : 2024/11/18 ~ 2024/12/09
15-
1622
<br>
1723

18-
1924
## 🍀 주요 기능
2025
> **주식 그래프**
2126
- **그래프 및 데이터 제공:** 종목별 투자 그래프와 비유적 설명이 담긴 뉴스레터 제공
@@ -35,7 +40,7 @@
3540
- 여러가지 아이템으로 흥미 제공.
3641

3742
<br>
38-
43+
3944
## 🍀 개발 환경 및 기술 스택
4045
### 통합 시스템 아키텍처
4146
![통합 시스템 아키텍처](https://github.com/user-attachments/assets/f6ddd958-6a68-4305-84c3-3e6f8098633f)
@@ -45,32 +50,36 @@
4550
## 🍀 개발 문서
4651
<details>
4752
<summary>ERD</summary>
53+
54+
[🔗 ERD 바로가기](https://www.erdcloud.com/d/FrEWNLqLuTPQ6rx2r)
55+
![ERD](https://github.com/user-attachments/assets/a3ab7508-4e59-48d0-9b99-f068861037ce)
56+
4857
</details>
4958
<details>
50-
<summary>아키텍처</summary>
59+
<summary>인프라 아키텍처</summary>
5160

52-
![백엔드 서버 아키텍처](https://github.com/user-attachments/assets/f96d2c88-223c-47b4-a673-ac613be39063)
61+
![백엔드 인프라 아키텍처](https://github.com/user-attachments/assets/f96d2c88-223c-47b4-a673-ac613be39063)
5362

5463
</details>
5564
<details>
5665
<summary>요구사항 명세서</summary>
5766

58-
[🔗 요구사항 명세서](https://foggy-move-190.notion.site/67c1e522ca8047d98094580d9bdc8f87?pvs=74)
67+
[🔗 요구사항 명세서 바로가기](https://foggy-move-190.notion.site/67c1e522ca8047d98094580d9bdc8f87?pvs=74)
5968
</details>
6069
<details>
6170
<summary>API 명세서</summary>
6271

63-
[🔗 API 명세서](https://foggy-move-190.notion.site/API-b44b55ec93c9478c9a25c9f75150b773?pvs=73)
72+
[🔗 API 명세서 바로가기](https://foggy-move-190.notion.site/API-b44b55ec93c9478c9a25c9f75150b773?pvs=73)
6473
</details>
6574

6675
## 🍀 팀 소개
6776

6877
### FRONTEND
69-
| 👑 이희주 | 📋 박우현 | 류민주 |
70-
|:----------------------------------------------------------:|:----------------------------------------------------------:|:-------------------------------------:|
71-
| FE TeamLeader | PM | Git_Admin |
72-
| [tree0000](https://github.com/tree0000) | [hjlee2778](https://github.com/hjlee2778) | [minij02](https://github.com/minij02) |
73-
| ![](https://avatars.githubusercontent.com/u/141895600?v=4) | ![](https://avatars.githubusercontent.com/u/144092849?v=4) | ![](https://avatars.githubusercontent.com/u/135093109?v=4)|
78+
| 👑 이희주 | 📋 박우현 | 류민주 |
79+
|:----------------------------------------------------------:|:----------------------------------------------------------:|:-----------------------------------------------------------:|
80+
| FE TeamLeader | PM | Git_Admin |
81+
| [hjlee2778](https://github.com/hjlee2778) | [tree0000](https://github.com/tree0000) | [minij02](https://github.com/minij02) |
82+
| ![](https://avatars.githubusercontent.com/u/144092849?v=4) | ![](https://avatars.githubusercontent.com/u/141895600?v=4) | ![](https://avatars.githubusercontent.com/u/135093109?v=4) |
7483

7584
### BACKEND
7685
| 👑 임지은 | 신은화 | 최재형 | 이수빈 | 박찬서 |

docs/branch-strategy.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,34 @@
1212
### 브랜치 네이밍
1313
* Issue 에서 브랜치 생성
1414
* main : 프로젝트가 최종적으로 배포되는 중심 브랜치입니다.
15-
* dev : 개발이 진행되는 브랜치입니다. dev 브랜치가 배포할 수준의 기능을 갖추면 release 브랜치로 머지됩니다.
15+
* develop : 개발이 진행되는 브랜치입니다. dev 브랜치가 배포할 수준의 기능을 갖추면 release 브랜치로 머지됩니다.
1616
* feature : 기능을 개발하는 브랜치입니다. dev 브랜치에서 파생되는 브랜치이며, dev 브랜치로 머지합니다.
17-
* release 브랜치에서 모든 테스트가 통과한 후 main 브랜치로 병합
18-
* CI/CD가 되어 있는 상태에서 바로 main 브랜치로 병합 시 배포 실패가 뜨는 것을 방지하고,
19-
추가 에러가 있는지 확인하는 과정이라고 생각해주세요.
20-
* hotfix 브랜치는 배포 된 후 생긴 에러의 긴급 상황에서 사용, 즉시 테스트 및 배포되어야 함
21-
* 필요 시 작업 별로 구분하기 위해서 Issue Tracker ID 사용
22-
`dev/feat/{기능명}/{#이슈번호}`
23-
24-
| 분류 | 내용 | 명명규칙 |
25-
| --- | --- | --- |
26-
| main | 최종적으로 배포되는 브랜치 | main |
27-
| develop | 개발 중인 코드가 모이는 브랜치 | dev |
28-
| feature | 새로운 기능을 개발하는 브랜치 | dev/feature/{기능명} /{#이슈번호} |
29-
| refactor | 개발된 기능을 리팩터링하는 브랜치 | dev/refactor/{기능명}/{#이슈번호} |
17+
* release : 배포 전 버전 기록을 남깁니다. 브랜치에서 모든 테스트가 통과한 후 main 브랜치로 병합
18+
* hotfix : 브랜치는 배포 된 후 생긴 에러의 긴급 상황에서 사용, 즉시 테스트 및 배포되어야 함
19+
* 작업 별로 구분하기 위해서 SCRUM-NUM 사용
20+
`feature/{도메인}/{#스크럼번호}`
21+
| 분류 | 내용 | 명명규칙 |
22+
| --- | --- |-----------------------------|
23+
| main | 최종적으로 배포되는 브랜치 | main |
24+
| develop | 개발 중인 코드가 모이는 브랜치 | develop |
25+
| feature | 새로운 기능을 개발하는 브랜치 | feature/{도메인}/{#스크럼번호} |
26+
| refactor | 개발된 기능을 리팩터링하는 브랜치 | refactor/{도메인}/{#스크럼번호} |
3027
| release | 배포를 준비하는 브랜치 | release/{버전} |
31-
| hotfix | 배포 된 후 발생한 버그를 수정하는 브랜치 | hotfix/(#이슈번호) |
32-
33-
※ 배포를 준비하는 브랜치는 dev 또는 release 에서 현재와 다르게 추후 변경될 수 있습니다.
28+
| hotfix | 배포 된 후 발생한 버그를 수정하는 브랜치 | hotfix/(#이슈번호) |
3429

3530
<br>
3631

3732
### 활용 예시
3833
```markdown
3934
main
4035

41-
dev/feature/login/#1
36+
develop
4237

43-
dev/feature/register/#12
38+
feature/register/#12
4439

45-
dev/refactor/login
40+
refactor/login
4641

47-
release/1.0.0
42+
release/V1.0.0
4843

4944
hotfix/#22
5045
```

docs/commit-convention.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,19 @@ footer
1717

1818
### The Type
1919

20-
| 타입 | 설명 |
21-
| --- | --- |
22-
| Feat | 새로운 기능 |
23-
| Fix | 버그 수정 |
24-
| Docs | 문서 변경 사항 |
25-
| Style | 서식, 세미콜론 누락 등; 코드 변경 없음, 파일, 폴더명 변경 및 이동, 제거 |
26-
| Refactor | 프로덕션 코드 리팩토링 |
27-
| Test | 테스트 추가, 테스트 리팩토링; 프로덕션 코드 변경 없음 |
20+
| 타입 | 설명 |
21+
| --- |-----------------------------------------|
22+
| Feat | 새로운 기능 |
23+
| Fix | 버그 수정 |
24+
| Refactor | 프로덕션 코드 리팩토링 |
25+
| Test | 테스트 추가, 테스트 리팩토링; 프로덕션 코드 변경 없음 |
2826
| Chore | 빌드 작업, 패키지 관리자 구성 등 업데이트, 프로덕션 코드 변경 없음 |
29-
| | |
30-
| Add | 코드 추가 |
31-
| Modify | 코드 수정 |
27+
| Docs | 문서 변경 사항 |
28+
| Style | 서식, 세미콜론 누락, 주석 추가 및 제거 등; 코드 변경 없음 |
29+
| Modify | 코드 추가 및 수정, 파일 또는 폴더명 변경 및 이동, 제거 |
3230

3331
※ Merge Commit Message는 기본 세팅을 따른다.
34-
Add, Modify는 Feat 으로 새로운 기능 추가 후 추가 수정 시 사용
32+
※ Modify는 Feat 으로 새로운 기능 추가 후 추가 수정 시 사용
3533

3634
<br>
3735

@@ -42,12 +40,12 @@ footer
4240
* 문장의 끝에 마침표를 사용하지 않음
4341
* 명령형
4442
* 태그: 제목 형식으로 커밋 내용을 유의미하게 전달
45-
* Type: (도메인)-(구현내용)
46-
* 파일명, 도메인은 영문 그대로 사용
43+
* Type: (도메인) (구현내용)
44+
* 파일명, 도메인은 영문 그래도 사용
4745
* 내용은 최대한 한글 사용
4846

4947
```
50-
Feat: friend-친구 목록 기능 구현
48+
Feat: friend 친구 목록 기능 구현
5149
5250
* 친구 목록 조회 기능
5351
* 친구 신청 기능
@@ -82,7 +80,7 @@ Feat: friend-친구 목록 기능 구현
8280
### Example Commit Message
8381

8482
```
85-
Feat: member-로그인 기능 구현
83+
Feat: member 로그인 기능 구현
8684
8785
로그인 시 JWT 발급
8886

0 commit comments

Comments
 (0)