boostcampwm-2022/web16-Codocs

# ✍️ 함께 쓰는 공동 문서, Codocs

CRDT 기반 실시간 공동 문서 편집 웹 어플리케이션

[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fboostcampwm-2022%2Fweb16-Codocs&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true)](https://hits.seeyoufarm.com)

| |:--:| |

[codocs.site](https://codocs.site)

프로젝트 소개

공동 편집 기능을 만들고 싶다는 의지 하나로 진행된 프로젝트!!

실시간으로 다른 사람과 함께 문서를 편집해보세요.

🤷‍♂️ : Are you guys on the same page?

👨‍👨‍👦 : Yes, cause we are on Codocs!

실행 방법

frontend

npm run start:dev

backend/socket

npm run start:dev

backend/api

npm run start:dev

.env.development 파일 모음

Gist - Frontend
Gist - Backend/Socket
Gist - Backend/API

Electron (macOS) 데스크탑 앱 설치

Release 를 참고해주세요
GitHub - Release

팀원 소개

#### Team. 부스트캠프로5행시해보겠습니다 |J001 강보석|J128 윤기석|J164 이현빈| |:-:|:-:|:-:| |

주요 기능

1️⃣ 실시간 공동 편집 & 공유 커서

![실시간 공동 편집 기능](https://user-images.githubusercontent.com/31645195/207755391-30765b48-e845-4589-a179-9a1f73403d2b.gif)

2️⃣ 문서 링크 공유

![문서 링크 공유](https://user-images.githubusercontent.com/31645195/207755387-525c6bd0-7671-4d77-9095-1b4b05b3a7d5.gif)

3️⃣ 접속 중인 사용자 확인

![접속 중인 사용자 확인](https://user-images.githubusercontent.com/31645195/207755394-113c8955-1091-4fbd-9125-ab209b54e39d.gif)

4️⃣ 마크다운 뷰어

![마크다운 뷰어](https://user-images.githubusercontent.com/31645195/207755397-3e8005fa-5eb7-48b3-ad79-610e14ac53d0.gif)

5️⃣ 문서 저장과 불러오기

![문서 저장과 불러오기](https://user-images.githubusercontent.com/31645195/207755404-408fc3e0-02a6-471c-a7b1-33837050527d.gif)

아키텍쳐

기술 스택

링크

|[Notion](https://5-line-poem-with-bstcp.notion.site/codocs-d5051e495a0640ebacc8cadebde4b54e)|[Figma](https://www.figma.com/file/4ouMjFJWdbdYPUwSf6WEMO/Codocs?node-id=0%3A1)|[GoogleSheet](https://docs.google.com/spreadsheets/d/1zg6LNgrADmZ-ABg8H5B5nIpRaAqmZvLjx29GzCOUoeo/edit#gid=0)|[GitHub wiki](https://github.com/boostcampwm-2022/web16-Codocs/wiki) |:-:|:-:|:-:|:-:|