From b5935abaf8b09469b4725e298796b0e9973d326d Mon Sep 17 00:00:00 2001 From: Yeongjun Kim Date: Mon, 10 Jun 2024 18:26:03 +0900 Subject: [PATCH 1/2] =?UTF-8?q?chore:=20README.md=20=ED=8C=8C=EC=9D=BC=20?= =?UTF-8?q?=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 115 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 65 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 158720ae..15cc6831 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,71 @@ -
+![스크린샷 2024-01-23 오전 1 42 31](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/aa341f05-3915-425a-b439-c26e644425d9) -![main](https://github.com/Team-TenTen/LinkHub-FE/assets/39931980/3627e31b-e8fe-471f-a1df-6106a072d563) +## 🔗 LinkHub 🔗 -

LinkHub

+> 링크 아카이빙 및 공유 서비스 -[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fprgrms-fe-devcourse%2FFEDC4_Angola_NaYoung&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com) +## 🔗 프로젝트 기간 🔗 -LinkHub 바로가기  |  팀 노션  |  기획서 +> 프로젝트 기간 : 2023/10/10 ~ 2023/12/05 -
+## 🔗 프로젝트 기획 배경 및 동기 🔗 -
+> 저희는 아래와 같은 불편함들을 해결하기 위해 LinkHub 서비스를 기획했습니다. -## 실행 방법 +- 기존 브라우저의 북마크만으로는 계층 별로 정리하거나 구분하기에 한계가 존재한다. +- 기존 북마크의 경우, 묶인 링크를 한 사람만 확인할 수 있으며 다른 사용자와의 공유가 불편하다. +- 슬랙 혹은 카카오 단톡방에 링크 공유 시 다른 텍스트 메세지들에 의해 해당 링크가 자주 묻힌다. +- 슬랙 혹은 단톡방에서 팀원들이 해당 링크를 봤는지 확인하고 싶다. +- 슬랙 혹은 카카오 단톡방에 링크를 공유하면 해당 링크를 본 인원들을 파악하고 싶다. +- 지역 맛집 혹은 쇼핑몰 등을 검색하면 양질의 정보가 아닌 많은 광고들로 인해 정보를 필터링하는 추가적인 비용이 소모된다. -``` -npm install -``` +## 🔗 기능 시연 🔗 -``` -npm run dev -npm run build -``` +### 메인 화면 및 검색 -
+좋아요를 많이 받은 상위 링크들과 최신순 혹은 즐겨찾기 순의 스페이스(링크 저장소)를 필터링하여 보여준다. 또한 검색 기능을 제공하여 편의성 확보 +| 메인 페이지 | 스페이스(링크 저장소) 검색 | 유저 검색 | +|:---:|:---:|:---:| +| ![메인 페이지](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/14368d47-d597-4bac-a375-4886b10f3eb4) | ![스페이스(링크 저장소) 검색](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/4ace19c3-0419-4955-a4de-1b2e355046de) | ![유저 검색](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/de209ba9-8871-4953-b86e-18360a794269) | -## 기술 스택 +### 링크 아카이빙 -
- -image +링크의 메타태그를 통해 자동으로 제목을 추천해주며 태그를 통해 추후 필터링의 용이성을 올림 +| 링크 생성 | 링크 필터링 | +|:---:|:---:| +| | | -
+### 공유 아카이빙 공간 + +스페이스 초대 기능을 통해 언제든지 팀원들을 초대할 수 있으며 viewer 및 editor 등의 세부 권한 지정이 가능하다. 또한 설정 시 팀원들의 링크 조회 이력을 표시할 수 있다. +| 초대 하기 | 초대 받기 | 링크 조회 이력 표시 | +|:---:|:---:|:---:| +| ![초대 하기](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/cae806df-b646-491d-97ba-611179d92cc7) | ![초대 받기](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/9ed2649d-49ce-4209-9136-84b29e2a938e) | ![링크 조회 이력 표시](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/e4748848-8b7e-41af-9a40-cb0de6524f28) | + +### 즐겨찾기 + +공개된 스페이스(링크 저장소)는 즐겨찾기 기능을 통해 구독을 할 수 있다. 또한 많은 유저들에게 즐겨찾기된 스페이스는 메인화면 즐겨찾기 순 옵션에서 상위에 노출되게 된다. +| 즐겨찾기 | +|:---:| +| | + +### 가져오기 + +공개된 스페이스(링크 저장소)를 복사하여 편집 가능한 나의 스페이스로 만들 수 있다. 즐겨찾기와 다르게 원본의 이후 변경사항은 반영되지 않는다. +| 가져오기 | +|:---:| +| | + +### 댓글 + +댓글이 허용된 스페이스(링크 저장소)는 댓글을 작성할 수 있으며 대댓글도 작성할 수 있다. +| 댓글 확인 | 댓글 쓰기 | +|:---:|:---:| +| | |
-## 팀원 소개 +## 👨‍👩‍👦 팀원 소개
@@ -57,39 +87,24 @@ npm run build
-
- -## 서비스 개요 - -### LinkHub란 ? +## 💻 기술 스택 -**링크 아카이빙 및 공유 서비스** - -
- -### 서비스 주요 기능 - -**1. 링크 아카이빙**
- - image - -
-
- -**2. 공유 아카이빙 공간**
+
+ +image - image +

-
- -**3. 스페이스 즐겨찾기**
- image +## 👨‍👩‍👦 협업 툴 -
-
+| Notion | Slack | Discord | GitHub | Figma | +| :-------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | +| | | | | | -**4. 스페이스 가져오기**
+## 문서 - image +[🔗 LinkHub 기획서](https://www.notion.so/prgrms/LinkHub-546003d57aa34297a09ee98efa65cc25?pvs=4)
+[📔 LinkHub 유저 스토리 ](https://www.notion.so/prgrms/3306a1d774f74a3288e8f3f2a9ecb427?pvs=4)
+[📁 LinkHub API 명세서 ](https://www.notion.so/prgrms/API-c9e7dd4d09b246999a0022273810e4f7?pvs=4)
From aa4fe7cc0e5d87e29f3f12b011dff6e06346afcd Mon Sep 17 00:00:00 2001 From: Yeongjun Kim Date: Mon, 10 Jun 2024 19:10:31 +0900 Subject: [PATCH 2/2] =?UTF-8?q?chore:=20README.md=20=ED=8C=8C=EC=9D=BC=20?= =?UTF-8?q?=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 46 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 15cc6831..b637ad67 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,32 @@ ![스크린샷 2024-01-23 오전 1 42 31](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/aa341f05-3915-425a-b439-c26e644425d9) +
+ ## 🔗 LinkHub 🔗 > 링크 아카이빙 및 공유 서비스 +
+ ## 🔗 프로젝트 기간 🔗 > 프로젝트 기간 : 2023/10/10 ~ 2023/12/05 +
+ ## 🔗 프로젝트 기획 배경 및 동기 🔗 -> 저희는 아래와 같은 불편함들을 해결하기 위해 LinkHub 서비스를 기획했습니다. +> 저희는 아래와 같은 불편함을 해결하기 위해 LinkHub 서비스를 기획했습니다. - 기존 브라우저의 북마크만으로는 계층 별로 정리하거나 구분하기에 한계가 존재한다. - 기존 북마크의 경우, 묶인 링크를 한 사람만 확인할 수 있으며 다른 사용자와의 공유가 불편하다. -- 슬랙 혹은 카카오 단톡방에 링크 공유 시 다른 텍스트 메세지들에 의해 해당 링크가 자주 묻힌다. +- 슬랙 혹은 카카오 단톡방에 링크 공유 시 다른 텍스트 메시지들에 의해 해당 링크가 자주 묻힌다. - 슬랙 혹은 단톡방에서 팀원들이 해당 링크를 봤는지 확인하고 싶다. - 슬랙 혹은 카카오 단톡방에 링크를 공유하면 해당 링크를 본 인원들을 파악하고 싶다. - 지역 맛집 혹은 쇼핑몰 등을 검색하면 양질의 정보가 아닌 많은 광고들로 인해 정보를 필터링하는 추가적인 비용이 소모된다. +
+ ## 🔗 기능 시연 🔗 ### 메인 화면 및 검색 @@ -28,13 +36,17 @@ |:---:|:---:|:---:| | ![메인 페이지](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/14368d47-d597-4bac-a375-4886b10f3eb4) | ![스페이스(링크 저장소) 검색](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/4ace19c3-0419-4955-a4de-1b2e355046de) | ![유저 검색](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/de209ba9-8871-4953-b86e-18360a794269) | +
+ ### 링크 아카이빙 -링크의 메타태그를 통해 자동으로 제목을 추천해주며 태그를 통해 추후 필터링의 용이성을 올림 +링크의 메타태그를 통해 자동으로 제목을 추천해 주며 태그를 통해 추후 필터링의 용이성을 올림 | 링크 생성 | 링크 필터링 | |:---:|:---:| | | | +
+ ### 공유 아카이빙 공간 스페이스 초대 기능을 통해 언제든지 팀원들을 초대할 수 있으며 viewer 및 editor 등의 세부 권한 지정이 가능하다. 또한 설정 시 팀원들의 링크 조회 이력을 표시할 수 있다. @@ -42,6 +54,8 @@ |:---:|:---:|:---:| | ![초대 하기](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/cae806df-b646-491d-97ba-611179d92cc7) | ![초대 받기](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/9ed2649d-49ce-4209-9136-84b29e2a938e) | ![링크 조회 이력 표시](https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/e4748848-8b7e-41af-9a40-cb0de6524f28) | +
+ ### 즐겨찾기 공개된 스페이스(링크 저장소)는 즐겨찾기 기능을 통해 구독을 할 수 있다. 또한 많은 유저들에게 즐겨찾기된 스페이스는 메인화면 즐겨찾기 순 옵션에서 상위에 노출되게 된다. @@ -49,6 +63,8 @@ |:---:| | | +
+ ### 가져오기 공개된 스페이스(링크 저장소)를 복사하여 편집 가능한 나의 스페이스로 만들 수 있다. 즐겨찾기와 다르게 원본의 이후 변경사항은 반영되지 않는다. @@ -56,6 +72,8 @@ |:---:| | | +
+ ### 댓글 댓글이 허용된 스페이스(링크 저장소)는 댓글을 작성할 수 있으며 대댓글도 작성할 수 있다. @@ -65,7 +83,7 @@
-## 👨‍👩‍👦 팀원 소개 +## 👤 팀원 소개
@@ -87,13 +105,23 @@
+
+ ## 💻 기술 스택 -
- -image +### 기술 -
+ + + + + + +### 인프라 + + + +
@@ -103,6 +131,8 @@ | :-------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | | | | | | | +
+ ## 문서 [🔗 LinkHub 기획서](https://www.notion.so/prgrms/LinkHub-546003d57aa34297a09ee98efa65cc25?pvs=4)