From cc244fe4006cd28a17b12d1471b6821c829acfc0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=EB=82=98=EA=B0=B1?=
<109855280+nagaeng@users.noreply.github.com>
Date: Sat, 11 Jan 2025 17:17:59 +0900
Subject: [PATCH] [doc] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
- gif 추가 필요
- 의존성 모듈 그래프 수정 필요
---
README.md | 123 ++++++++++++++++++++++++++++++++----------------------
1 file changed, 72 insertions(+), 51 deletions(-)
diff --git a/README.md b/README.md
index ddd54957..04a16bcd 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,12 @@
-
+
-## 🌊 유영
-**유저가 ‘공간’을 ‘영상’으로 디깅하고, 나만의 ‘공간 취향’을 발견하는 서비스**
+## 🍪 Viskit (비스킷)
+**공간을 직접 영상으로 체험하고, 소셜 네트워킹을 통해 의견을 나누는 새로운 방식의 공간 탐색 서비스**
## 🔢 목차
[프로젝트 설명](#프로젝트-설명)
[주요 기능](#주요-기능)
+[고객 지원](#고객-지원)
[시연 영상](#시연-영상)
[기술 및 아키텍쳐 선정](#기술-및-아키텍쳐-선정)
[컨벤션 규칙 및 브랜치 전략](#컨벤션-규칙-및-브랜치-전략)
@@ -14,75 +15,89 @@
[의존성 그래프](#의존성-그래프)
[폴더링](#폴더링)
-## 🅿️ 프로젝트 설명
-'유영'은 내 취향에 맞는 공간을 촬영하고 업로드하는 숏폼을 활용하는 라이프스타일 플랫폼입니다. 사용자들은 새로운 장소를 자유롭게 둘러보고 취향을 찾으며, 다른 사용자들과 공간 경험을 나눌 수 있습니다. 동영상을 활용하여 방문 전에도 실제와 유사한 공간감을 느낄 수 있는 공간영상을 제공합니다. 또한 키워드와 취향에 맞는 유저 구독 기능을 통해 무분별한 알고리즘에서 벗어나 취향에 맞는 공간 정보만 탐색할 수 있도록 하는 가치를 제공합니다.
+## 🎥 프로젝트 설명
+비스킷은 공간을 영상으로 솔직하게 공유하는 소셜 네트워크 서비스입니다. 1분 이내의 생생한 리뷰 영상으로 내가 찾던 완벽한 공간을 발견하고, 간편한 길 찾기와 커뮤니티를 통해 새로운 공간 경헐을 나눌 수 있습니다. 비스킷은 영상 리뷰와 소셜 네트워크를 결합하여 공간 탐색의 새 기준을 제시하고자 합니다.
## 📍 주요 기능
-1. 내 공간 경험 업로드하기: 사용자가 다양한 장소를 촬영한 공간감이 느껴지는 짧은 영상을 앱에 업로드할 수 있으며, 간편한 인터페이스로 촬영부터 업로드까지 손쉽게 진행할 수 있습니다.
-2. 취향 분석표 수집하기: 사용자 취향을 분석하여 맞춤형 취향 분석표를 제공합니다. 나만의 분석표를 받고 공간 취향을 알아볼 수 있습니다.
-3. 취향 기반 유저의 소식 받기: 다른 유저를 팔로우하고, 그들의 영상을 저장하고 소식을 받을 수 있습니다.
-4. 관심 있는 공간 저장하기: 마음에 드는 공간 영상을 저장하고, 쉽게 보관할 수 있습니다.
-
-## 📹 시연 영상
+1. 1분 영상으로 공간 탐색 : 비스킷은 **1분 이내의 영상**을 통해 다양한 공간을 소개해요. 짧은 시간 안에 공간의 분위기와 특징을 파악할 수 있어 방문 전에 충분한 정보를 얻을 수 있어요!
+2. 간편한 길찾기 : 앱 내에서 **터치 한 번**으로 원하는 장소까지의 길을 쉽게 찾을 수 있어요. 복잡한 길찾기 과정 없이 바로 목적지로 이동할 수 있어 편리해요!
+3. 솔직한 리뷰와 소통 : 다른 사용자들이 공유한 영상과 리뷰를 통해 공간에 대한 진솔한 정보를 얻을 수 있어요. 또한, 댓글과 좋아요 기능을 통해 사용자들과 소통하며 새로운 장소를 발견하는 재미를 느낄 수 있어요!
+## 💬 고객 지원
+- 문의 : team recordy@gmail.com
+- 인스타그램 : @viskit_official
-**전체 영상**
+## 📹 시연 영상
- |
- |
- |
- |
+ |
+ |
+ |
+ |
스플래시 |
- 카카오 |
- 홈 키워드 |
- 홈 북마크 |
+ 로그인 |
+ 홈 (메인) |
+ 홈 위치 기능 on/off |
+
+
+
+
+ |
+ |
+ |
+ |
+
+
+ 영상 메인 +)무한 스크롤 보여주면 됩니다!! |
+ 영상 상세 +)캡션 펼치기 및 북마크 on/off 보여주면 됩니다!! |
+ 영상 신고 +)더보기 버튼 관련 보여주면 됩니다!! |
+ 타 유저 프로필 +)팔로잉 하는 거 말고 그냥 스크롤, 영상 접속 보여주면 됩니다!! |
- |
- |
- |
- |
+ |
+ |
+ |
+ |
- 업로드 |
- 인기 기록> |
- 최신 기록 |
- 내 영상 삭제 |
+ 장소 상세 페이지 |
+ 장소 길찾기 +)장소 찾아 모달 접속까지 보여주시면 됩니다!! |
+ 장소 리뷰 |
+ 검색 기본 +)검색 기본, 중, 완료는 피그마대로 끊어서 보여주시면 됩니다!! |
- |
- |
- |
- |
+ |
+ |
+ |
+ |
- 프로필(내 취향) |
- 프로필(내 기록) |
- 프로필(북마크) |
- 팔로잉/팔로워 |
+ 검색중 |
+ 검색 완료 |
+ 업로드 장소 검색 및 장소 등록 |
+ 업로드 내용 입력 +)장소 등록 제외한 내용 입력하여 업로드 하는 거까지 보여주시면 됩니다!! |
- |
- |
- |
- |
+ |
+ |
+ |
+ |
- 상대 프로필 |
- 영상 디테일 |
- 환경 설정 |
- 로그아웃/탈퇴 |
+ 프로필 |
+ 프로필 수정 |
+ 영상 삭제 |
+ 팔로잉/ 팔로워 +)취소하고 들어가서 다시 팔로우하는 거 보여주면 됩니다!! |
@@ -106,17 +121,18 @@
**브랜치 전략:** [Branch Strategy](https://bohyunnkim.notion.site/Branch-Strategy-9d989f5c36ca44ffaae40e436056f966)
## 👨👩👧👦 파트원 사진
-
+
## 👤 팀원별 역할 분담
-||||||
+|[![우상욱](https://github.com/user-attachments/assets/e9f5a10a-b2b9-4393-a867-074a9a384b92)](https://github.com/Sangwook123)|[![김명석](https://github.com/user-attachments/assets/2cc63802-0c2d-4fe9-95f4-cea5e5e735a4)](https://github.com/cacaocoffee)|[![이삭](https://github.com/user-attachments/assets/15305a76-b412-4afb-afe8-8fb983baca96)](https://github.com/lsakee)|[![이나경](https://github.com/user-attachments/assets/a2568e1b-dd42-454d-8a50-2f58b60335d9)](https://github.com/nagaeng)|[![윤서희](https://github.com/user-attachments/assets/8a6a551e-2de4-4399-bb9f-4cd114d2669b)](https://github.com/seohee0925)|
|:---------:|:---------:|:---------:|:---------:|:---------:|
-|[👑우상욱](https://github.com/Sangwook123)|[김명석](https://github.com/cacaocoffee)|[이삭](https://github.com/lsakee)|[이나경](https://github.com/nagaeng)|[윤서희](https://github.com/seohee0925)|
-| `홈, 영상` | `로그인` | `기록` | `프로필` | `팔로우, 상대` |
+|[우상욱](https://github.com/Sangwook123)|[김명석](https://github.com/cacaocoffee)|[이삭](https://github.com/lsakee)|[이나경](https://github.com/nagaeng)|[윤서희](https://github.com/seohee0925)|
+|`홈, 영상`|`로그인, 프로필 수정`|`업로드`|`프로필 기본, 상세`|`팔로우, 검색`|
+
## 🪽 의존성 그래프
-
+
## 🗂️ 폴더링
@@ -129,35 +145,40 @@
│ ├── 🗂️ buildconfig
├── 📁:data
│ ├── 🗂️ auth
+│ ├── 🗂️ exhibition
│ ├── 🗂️ keyword
-│ ├── 🗂️ mypage
│ ├── 🗂️ oauth
│ ├── 🗂️ user
│ ├── 🗂️ video
├── 📁:local
│ ├── 🗂️ auth
│ ├── 🗂️ user
+│ ├── 🗂️ video
├── 📁:remote
│ ├── 🗂️ auth
+│ ├── 🗂️ exhibition
│ ├── 🗂️ keyword
│ ├── 🗂️ user
│ ├── 🗂️ video
├── 📁:domain
│ ├── 🗂️ auth
+│ ├── 🗂️ exhibition
│ ├── 🗂️ keyword
│ ├── 🗂️ oauth
│ ├── 🗂️ upload
│ ├── 🗂️ user
│ ├── 🗂️ video
├── 📁:feature
-│ ├── 🗂️ navigator
+│ ├── 🗂️ detail
│ ├── 🗂️ home
│ ├── 🗂️ login
│ ├── 🗂️ mypage
+│ ├── 🗂️ navigator
│ ├── 🗂️ profile
+│ ├── 🗂️ search
+│ ├── 🗂️ setting
│ ├── 🗂️ upload
│ ├── 🗂️ video
-│ ├── 🗂️ setting
├── 📁:gradle
│ ├── libs.versions.toml
```