https://github.com/boostcampwm2023/ios10-openlist
친구와 함께, AI와 함께 체크리스트 작성을! 오리
https://github.com/boostcampwm2023/ios10-openlist
clova-studio-api crdt-algorithm gpt-4-api ios-swift server-nestjs
Last synced: 9 months ago
JSON representation
친구와 함께, AI와 함께 체크리스트 작성을! 오리
- Host: GitHub
- URL: https://github.com/boostcampwm2023/ios10-openlist
- Owner: boostcampwm2023
- Created: 2023-11-06T01:33:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T01:53:01.000Z (over 2 years ago)
- Last Synced: 2025-09-12T20:04:35.680Z (9 months ago)
- Topics: clova-studio-api, crdt-algorithm, gpt-4-api, ios-swift, server-nestjs
- Language: Swift
- Homepage: https://openlist.kro.kr
- Size: 80.7 MB
- Stars: 16
- Watchers: 3
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
2023.10.17 ~
# Content
- [소개영상](#소개영상)
- [주요기능](#주요기능)
- [기술적 도전](#기술적-도전)
- [기술 스택](#기술-스택)
- [아키텍처](#아키텍처)
- [문서](#프로젝트-문서)
- [팀 소개](#TEAM)
- [위키](https://github.com/boostcampwm2023/iOS10-OpenList/wiki)
# 소개영상
https://github.com/boostcampwm2023/iOS10-OpenList/assets/51476641/29ab52ca-06a4-4a99-a6af-4290936f8823
# 주요기능
## AI
> 체크리스트 작성이 어려운 사람들을 위해 AI 추천기능을 구현하였습니다.
>
> GPT-4를 이용한 체크리스트 캐싱 시스템, CLOVA Studio를 이용한 평가 시스템을 도입하여 빠르고 정확한 정보를 제공합니다.
체크리스트 작성을 위해 카테고리를 선택해주세요
선택된 카테고리로 AI가 체크리스트를 추천해줘요
AI가 추천한 목록들로 개인 체크리스트를 만들어요
## 동시편집!
> 여러명과 동시에 체크리스트를 작성하기 위해 동시편집 기능을 구현하였습니다.
>
> 동시편집은 CRDT 알고리즘 중에 RGATreeSplit 방식을 채택하였습니다.
개인 체크리스트를 함께 작성하도록 변경할 수 있어요
친구를 초대하여 체크리스트를 같이 작성할 수 있어요
동시편집시 현재 편집중인 친구의 위치를 알 수 있어요
- [[동시편집] CRDT vs OT](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-CRDT-vs-OT)
- [[동시편집] 왜 RGATreeSplit 방식을 채택하였나?](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-%EC%99%9C-RGASplitTree-%EB%B0%A9%EC%8B%9D%EC%9D%84-%EC%B1%84%ED%83%9D%ED%95%98%EC%98%80%EC%9D%84%EA%B9%8C%3F)
- [[동시편집] ID 부여 방식](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-CRDT-ID-%EB%B6%80%EC%97%AC%EB%B0%A9%EC%8B%9D)
- [[동시편집] Tree 방식에서 밸런싱](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-Tree-%EB%B0%A9%EC%8B%9D%EC%97%90%EC%84%9C-%EB%B0%B8%EB%9F%B0%EC%8B%B1)
- [[동시편집] 자소분리 문제 해결과정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-%EC%9E%90%EC%86%8C%EB%B6%84%EB%A6%AC-%ED%95%B4%EA%B2%B0%EA%B3%BC%EC%A0%95)
# [기술적 도전](https://msmspark.notion.site/OPENLIST-a14eede6efb643698f166a0512f4206d?pvs=4)
## 📡 [Redis Pub/Sub과 서버 다중화]()
- 🔗 **서버 다중화**: Redis의 Pub/Sub 모델을 활용하여 서버 다중화를 구현하고, 효율적인 트래픽 분산 및 높은 확장성을 실현했습니다.
- 🔄 **실시간 데이터 스트리밍**: 앱에서는 CRDT를 활용하여 실시간으로 체크리스트를 업데이트하고, 서버는 Redis의 list 자료구조를 이용해 데이터 어레이를 모두 유지하여 사용자의 연결의 끊어져도, 문서에 대한 실시간 최신 상태를 유지합니다.
## 🌐 [Pipe & Filter 아키텍처와 인공지능 데이터 캐싱](https://msmspark.notion.site/Pipe-Filter-fd5f1bbd49934b978f820e9b4ff8d450)
- ⚡ **응답 시간 최적화**: DB에서 카테고리별로 캐싱된 데이터를 활용하여 Clova Studio API 응답 시간을 단축했습니다.
- 🛠 **캐싱 파이프라인**: Pipe & Filter 아키텍처를 적용하여 순차적 데이터 처리와 Redis Pub/Sub을 통한 효율적인 데이터 관리를 구현했습니다.
## 💻 [관리자 웹 페이지를 통한 시스템 모니터링]()
- 📊 **실시간 모니터링**: 프로덕션 환경에서 서버 상태를 모니터링하고 장애를 신속하게 관리할 수 있는 관리자 페이지를 구축했습니다.
- 📈 **데이터 관리 및 로깅**: Redis를 통해 시스템 로그를 관리하고, 캐싱 데이터 생성 및 평가 파이프라인을 트리거할 수 있는 기능을 통합했습니다.
https://github.com/boostcampwm2023/iOS10-OpenList/assets/51476641/e1e9a40e-8562-4dd9-b6f3-8c79abe34c4f
# 기술 스택
iOS
 -lightgrey?style=flat-square&logo=apple)
💻 서버
 
  
# 아키텍처
### iOS 아키텍처
### 서버 아키텍처
# 프로젝트 문서
## iOS
### 기술 문서
|번호|제목|키워드|
|:---|:---|:---|
|1|[CRDT vs OT](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-CRDT-vs-OT)|**`CRDT`**|
|2|[왜 RGATreeSplit 방식을 채택하였나?](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-%EC%99%9C-RGASplitTree-%EB%B0%A9%EC%8B%9D%EC%9D%84-%EC%B1%84%ED%83%9D%ED%95%98%EC%98%80%EC%9D%84%EA%B9%8C%3F)|**`CRDT`**|
|3|[ID 부여 방식](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-CRDT-ID-%EB%B6%80%EC%97%AC%EB%B0%A9%EC%8B%9D)|**`CRDT`**|
|4|[Tree 방식에서 밸런싱](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-Tree-%EB%B0%A9%EC%8B%9D%EC%97%90%EC%84%9C-%EB%B0%B8%EB%9F%B0%EC%8B%B1)|**`CRDT`**|
|5|[자소분리 문제 해결과정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EB%8F%99%EC%8B%9C%ED%8E%B8%EC%A7%91%5D-%EC%9E%90%EC%86%8C%EB%B6%84%EB%A6%AC-%ED%95%B4%EA%B2%B0%EA%B3%BC%EC%A0%95)|**`CRDT`**|
|6|[딥링크로 체크리스트 초대하기](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/딥링크로-체크리스트-초대하기)|**`딥링크`**|
|7|[프레임워크 vs 라이브러리](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BFramework-&-Library%5D-%EB%AC%B4%EC%97%87%EC%9D%B4-%EB%A7%9E%EC%9D%84%EA%B9%8C)|**`모듈`**|
|8|[소켓통신: Any와의 싸움](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5B%EC%86%8C%EC%BC%93%ED%86%B5%EC%8B%A0%5D-Any-Type%EA%B3%BC%EC%9D%98-%EC%8B%B8%EC%9B%80)|**`소켓`**|
### 의사결정 기록
|제목|키워드|
|:---|:---|
[[ADR] 아키텍처 의사 결정 기록: iOS 애플리케이션 아키텍처 채택하기](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-iOS-애플리케이션-아키텍처-채택하기)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: SwiftLint 채택](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:--SwiftLint-채택)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: UI 영역에서 Combine 사용 결정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-UI-영역에서-Combine-사용-결정)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: Presentation영역의 ViewModel에서 Input Output 패턴 도입 결정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-Presentation영역의-ViewModel에서-Input-Output-패턴-도입-결정)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: 코디네이터 패턴 도입 결정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-코디네이터-패턴-도입-결정)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: 로컬 스토리지로 코어 데이터 사용 결정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-로컬-스토리지로-코어-데이터-사용-결정)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: Custom Network Foundation 라이브러리 구현 및 모듈화 결정](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-Custom-Network-Foundation-라이브러리-구현-및-모듈화-결정)|**`ADR`**|
|[[ADR] 아키텍처 의사 결정 기록: 웹 소켓을 뷰 컨트롤러에서 연결하도록 변경](https://github.com/boostcampwm2023/iOS10-OpenList/wiki/%5BADR%5D-아키텍처-의사-결정-기록:-웹-소켓을-뷰-컨트롤러에서-연결하도록-변경)|**`ADR`**|
## BE
### 기술 문서
|번호|제목|키워드|
|:---|:---|:---|
|1|[vpc 설정 feat. 서브넷 마스킹](https://www.notion.so/msmspark/vpc-feat-0a443c45a9ab4ea2abbab93ca5c9975d?pvs=4)|**`vpc`**|
|2|[public, private 서버 인스턴스 생성](https://www.notion.so/public-private-e34aadf4fcd94b09846ef796573dae55?pvs=21)|**`서브넷`**|
|3|[private 서버 인스턴스 NAT 게이트웨이 생성](https://www.notion.so/private-NAT-4986dbea4fa54f67bfd8e7b7edf85fd8?pvs=21)|**`NAT`**|
|4|[로컬에서 ssh tunneling을 통한 private 인스턴스 속 postgresql 서버 접속](https://www.notion.so/ssh-tunneling-private-postgresql-6479857528d54b0e9919368209c7c465?pvs=21)|**`ssh tunneling` `postgresql`**|
|5|[github actions와 docker를 통한 nest 서버 배포](https://www.notion.so/github-actions-docker-nest-dd8139f6d14348ec888d2029a6ff56c2?pvs=21)|**`github actions` `docker` `CI/CD`**|
|6|[Logger 설정 - winston middleware to interceptor](https://www.notion.so/Logger-winston-middleware-to-interceptor-24540c46ce5b4d1894ef77618f233565?pvs=21)|**`Logging` `Winston`**|
|7|[apple login](https://www.notion.so/apple-login-88997ef1090f49daabdc4cde407aa625?pvs=21)|**`OAuth` `Apple Login`**|
|8|[NestJS 서비스에서 CLOVA Studio API 연동](https://www.notion.so/NestJS-CLOVA-Studio-API-86cfae6c9ca34baab47950ef00787b50?pvs=21)|**`CLOVA Studio API`**|
|9|[Pipe & Filter 아키텍처와 인공지능 데이터 캐싱](https://msmspark.notion.site/Pipe-Filter-fd5f1bbd49934b978f820e9b4ff8d450)|**`Redis Pub/Sub`** |
# TEAM
|S006|S008|S021|J050|J080|
|:---:|:---:|:---:|:---:|:---:|
|
|
|
|
|
|
|[김성훈](https://github.com/SeongHunTed)|[김영균](https://github.com/klmyoungyun)|[위성철](https://github.com/wi-seong-cheol)|[박민성](https://github.com/pminsung12)|[양동석](https://github.com/YangDongsuk)|
|iOS|iOS|iOS|Backend|Backend|