Skip to content

Commit 0b55d44

Browse files
authored
docs: README의 문제 해결 과정 업데이트
1 parent 249e6df commit 0b55d44

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
</div>
1919

20-
## 🐙 프로젝트 소개
20+
# 🐙 프로젝트 소개
2121

2222
### 🕸️ 문서간의 관계를 한 눈에 볼 수 있는 지식 관리 툴
2323

@@ -41,12 +41,12 @@ https://github.com/user-attachments/assets/ad1f6dc9-50af-46e4-bac4-267b1432b301
4141

4242
### ⛺️ 공유가 가능한 개별 워크스페이스 제공
4343

44-
> 준비 중인 기능입니다.
44+
> 🚧 영상 준비 중.
4545
4646
<br>
4747

4848

49-
## 🛠️ 프로젝트 구조
49+
# 🛠️ 프로젝트 구조
5050

5151
### 🖥️ System Architecture
5252

@@ -62,42 +62,38 @@ https://github.com/user-attachments/assets/ad1f6dc9-50af-46e4-bac4-267b1432b301
6262

6363
</div>
6464

65-
## 🗺️ 프로젝트 타임라인
65+
# 🗺️ 프로젝트 타임라인
6666

6767
![project-timeline](https://github.com/user-attachments/assets/2ae32844-ac61-4fc6-bb19-93c40f4f8f23)
6868

6969

70-
## 🚧 옥토독스 팀이 겪은 문제와 해결과정
70+
# 🚧 문제와 해결과정
7171

7272
### 실시간 편집 구현 과정
7373

74-
Octodocs 팀은 핵심 기능인 에디터와 노드 캔버스의 실시간 편집을 위해 CRDT 라이브러리 YJS와 SocketIO를 어떻게 활용 했을까요? … (위키 수정 중)
74+
Octodocs 팀은 핵심 기능인 에디터와 노드 캔버스의 **실시간 편집** 위해 **CRDT** 라이브러리인 **YJS****SocketIO** 어떻게 활용 했을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
7575

7676
### 데이터 흐름 변경
7777

78+
YDoc과 소켓을 사용하면서도 RESTful 방식으로 일부 상태를 관리하던 구조를, YDoc 중심의 **단일 truth source**와 소켓 기반 **단방향 흐름**으로 단순화했습니다. 그 결과 모든 상태가 YDoc을 통해 일관성 있게 관리되며, 클라이언트와 서버 간 데이터 흐름도 간소화되었습니다. 중복 관리와 데이터 충돌을 줄이기 위한 이런 **data flow 변화**의 핵심은 무엇이었을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
79+
7880
### FE 프로젝트 구조 개선 과정
7981

80-
Octodocs 팀은 기존 프로젝트 구조의 문제점을 어떻게 파악했고, 어떤 방법으로 개선을 했을까요?
82+
Octodocs 팀은 기존 **프로젝트 구조** 문제점을 어떻게 파악했고, 어떤 방법으로 개선을 했을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
8183

8284
### 드래그 이벤트 발생 시 생기는 쿼리 최적화
8385

84-
### redis 캐싱으로 데이터베이스 부하 감소
85-
86-
Octodocs 팀은 yjs 라이브러리를 사용하여 실시간 문서 동시 편집을 구현했어요.
86+
**노트 카드를 드래그** 할 때, 그 위치를 DB에 저장하기 위해 **너무 많은 쿼리가 발생**하는 문제가 있었습니다. 이를 위해 **쿼리를 최적화**해야할 필요성이 생겼는데 이를 어떻게 해결할 수 있었을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
8787

88-
하지만 실시간 문서 동시 편집에서 발생하는 굉장히 많은 변경 사항을 모두 데이터베이스에 저장하기에는 데이터베이스 부하가 너무 발생했어요
89-
90-
그래서 Octodocs 팀은 redis를 도입하기로 결정했습니다!
91-
92-
저희는 왜 redis를 도입하기로 결정했고 또 redis를 어떻게 활용했을까요? → [위키 링크]
88+
### redis 캐싱으로 데이터베이스 부하 감소
9389

94-
[https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis를-통해-데이터베이스-쿼리-줄이기](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis%EB%A5%BC-%ED%86%B5%ED%95%B4-%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EC%BF%BC%EB%A6%AC-%EC%A4%84%EC%9D%B4%EA%B8%B0)
90+
실시간 문서 동시 편집에서 발생하는 굉장히 많은 변경 사항을 모두 데이터베이스에 저장하기에는 데이터베이스 부하가 너무 많이 발생했고, Octodocs 팀은 redis를 도입하기로 결정했습니다. 저희는 왜 redis를 도입하기로 결정했고 또 redis를 어떻게 활용했을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki/redis%EB%A5%BC-%ED%86%B5%ED%95%B4-%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EC%BF%BC%EB%A6%AC-%EC%A4%84%EC%9D%B4%EA%B8%B0)
9591

9692
### 개발 환경, 배포 환경 및 CI/CD에 대한 개선 과정
9793

98-
Octodocs 팀은 사용자 경험 향상은 물론, 일관된 코드 품질 유지와 개발자 친화적인 쾌적한 개발 환경 조성을 위해 많은 노력을 기울였습니다. 멀티 레포에서 모노레포로의 전환, GitHub Actions를 활용한 CI/CD 구축, Docker와 Docker Compose의 도입까지—우리는 어떤 변화를 거쳤을까요? [위키 링크]
94+
Octodocs 팀은 사용자 경험 향상은 물론, 일관된 코드 품질 유지와 개발자 친화적인 쾌적한 개발 환경 조성을 위해 많은 노력을 기울였습니다. 멀티 레포에서 모노레포로의 전환, GitHub Actions를 활용한 CI/CD 구축, Docker와 Docker Compose의 도입까지—우리는 어떤 변화를 거쳤을까요? [🔗 링크](https://github.com/boostcampwm-2024/web15-OctoDocs/wiki)
9995

100-
## 🧸 팀원 소개
96+
# 🧸 팀원 소개
10197
| [J032_김동준](https://github.com/djk01281) | [J075_김현준](https://github.com/Tolerblanc) | [J097_민서진](https://github.com/summersummerwhy) | [J162_유성민](https://github.com/ezcolin2) | [J248_진예원](https://github.com/yewonJin) |
10298
|:----------------------------------------:|:------------------------------------------:|:------------------------------------------------:|:----------------------------------------:|:----------------------------------------:|
10399
| <img width="204" alt="스크린샷 2024-10-29 오후 4" src="https://github.com/user-attachments/assets/71a5a38e-f60c-4f60-97e3-30d7a73a3c77"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 41 04" src="https://github.com/user-attachments/assets/e093f852-a6ea-4937-b0ce-b89276bd7135"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 41 55" src="https://github.com/user-attachments/assets/0f638ba9-a1ad-47b8-a874-957c0119384c"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 41 00" src="https://github.com/user-attachments/assets/1d77b650-70f1-4dee-9489-dc0122b7c9ff"> | <img width="204" alt="스크린샷 2024-10-29 오후 11 40 31" src="https://github.com/user-attachments/assets/db99b6b2-ae06-4758-8687-17ebb860a52b"> |

0 commit comments

Comments
 (0)