diff --git a/README.md b/README.md index 007c7bb6..d0df8c35 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,21 @@ -![리드미용 유영](https://github.com/Team-Recordy/Recordy-Android/assets/109855280/6eb852d9-2a07-4426-bc09-1b8c6dc982b2)
+img_yoo0_banner
## 🌊 유영 **유저가 ‘공간’을 ‘영상’으로 디깅하고, 나만의 ‘공간 취향’을 발견하는 서비스** ## 🔢 목차 -[프로젝트 설명](#프로젝트-설명)
-[우리가 해결하고자 하는 문제](#-우리가-해결하고자-하는-문제)
+[프로젝트 설명](#프로젝트-설명)
[주요 기능](#주요-기능)
-[시연 영상](#시연-영상)
-[파트원 사진](#파트원-사진)
-[팀원별 역할 분담](#팀원별-역할-분담)
-[컨벤션 규칙 및 브랜치 전략](#컨벤션-규칙-및-브랜치-전략)
-[폴더링](#폴더링)
+[시연 영상](#시연-영상)
+[기술 및 아키텍쳐 선정](#기술-및-아키텍쳐-선정)
+[컨벤션 규칙 및 브랜치 전략](#컨벤션-규칙-및-브랜치-전략)
+[파트원 사진](#파트원-사진)
+[팀원별 역할 분담](#팀원별-역할-분담)
+[의존성 그래프](#의존성-그래프)
+[폴더링](#폴더링)
## 🅿️ 프로젝트 설명 -내 취향에 맞는 공간을 촬영하고 업로드하는 숏폼을 활용하는 라이프스타일 플랫폼입니다. 사용자들은 새로운 장소를 자유롭게 둘러보고 취향을 찾으며, 다른 사용자들과 공간 경험을 나눌 수 있습니다. 동영상을 활용하여 방문 전에도 실제와 유사한 공간감을 느낄 수 있는 공간영상을 제공합니다. 또한 키워드와 취향에 맞는 유저 구독 기능을 통해 무분별한 알고리즘에서 벗어나 취향에 맞는 공간 정보만 탐색할 수 있도록 하는 가치를 제공합니다.

- - -## 🪼 우리가 해결하고자 하는 문제 -- 취향에 맞는 공간 정보를 받을 수 있는 플랫폼의 분산
-- 공간감을 느낄 수 없는 가공된 사진
-- 기존 플랫폼의 영상 알고리즘으로 내 취향에 맞지 않는 공간 노출

+'유영'은 내 취향에 맞는 공간을 촬영하고 업로드하는 숏폼을 활용하는 라이프스타일 플랫폼입니다. 사용자들은 새로운 장소를 자유롭게 둘러보고 취향을 찾으며, 다른 사용자들과 공간 경험을 나눌 수 있습니다. 동영상을 활용하여 방문 전에도 실제와 유사한 공간감을 느낄 수 있는 공간영상을 제공합니다. 또한 키워드와 취향에 맞는 유저 구독 기능을 통해 무분별한 알고리즘에서 벗어나 취향에 맞는 공간 정보만 탐색할 수 있도록 하는 가치를 제공합니다.

## 📍 주요 기능 @@ -29,53 +24,69 @@ 3. 취향 기반 유저의 소식 받기: 다른 유저를 팔로우하고, 그들의 영상을 저장하고 소식을 받을 수 있습니다.
4. 관심 있는 공간 저장하기: 마음에 드는 공간 영상을 저장하고, 쉽게 보관할 수 있습니다.

+## ⚙️ 기술 및 아키텍쳐 선정 ++ `IDE - Android Studio koala`
++ `Architecture - MVI, Clean Architecture`
++ `DI - Hilt`
++ `Network - Retrofit`
++ `Asynchronous - Coroutine, Flow`
++ `Jetpack - DataStore, Navigation, Media3(exoplayer)`
++ `CI - Github Actions`
++ `Image - coil`
++ `lint - ktlint`
++ `third party - amazon aws, kakao login, collapsing toolbar`

-## 👨‍👩‍👧‍👦 파트원 사진 -img_yoo0_android +## ❗ 컨벤션 규칙 및 브랜치 전략 +**깃 컨벤션:** [Git Convention](https://bohyunnkim.notion.site/Git-Convention-d384b7b4b6c149009a88ec5409a9c694?pvs=74)
+**코드 컨벤션:** [Code Convention](https://bohyunnkim.notion.site/Code-Convention-bc2e0e1601554f2792131c3942984dec)
+**브랜치 전략:** [Branch Strategy](https://bohyunnkim.notion.site/Branch-Strategy-9d989f5c36ca44ffaae40e436056f966)

+## 👨‍👩‍👧‍👦 파트원 사진 +img_yoo0_android
## 👤 팀원별 역할 분담 -|||||| +|||||| |:---------:|:---------:|:---------:|:---------:|:---------:| |[👑우상욱](https://github.com/Sangwook123)|[김명석](https://github.com/cacaocoffee)|[이삭](https://github.com/lsakee)|[이나경](https://github.com/nagaeng)|[윤서희](https://github.com/seohee0925)| -| `홈, 영상` | `로그인` | `기록` | `프로필` | `팔로잉/팔로워, 상대` |
- - - - -## ❗ 컨벤션 규칙 및 브랜치 전략 - -**깃 컨벤션:** [Git Convention](https://bohyunnkim.notion.site/Git-Convention-d384b7b4b6c149009a88ec5409a9c694?pvs=74)
-**코드 컨벤션:** [Code Convention](https://bohyunnkim.notion.site/Code-Convention-bc2e0e1601554f2792131c3942984dec)
-**브랜치 전략:** [Branch Strategy](https://bohyunnkim.notion.site/Branch-Strategy-9d989f5c36ca44ffaae40e436056f966)

+| `홈, 영상` | `로그인` | `기록` | `프로필` | `팔로우, 상대` |
+## 🪽 의존성 그래프 +img_module_graph
## 🗂️ 폴더링 ```bash ├── Recordy -├── 📁 app -├── 📁 build-logic +├── 📁:app +├── 📁:build-logic │ ├── 📁 convention -├── 📁 core +├── 📁:core │ ├── 🗂️ buildconfig -│ ├── 🗂️ common -│ ├── 🗂️ datastore -│ ├── 🗂️ model -│ ├── 🗂️ network -│ ├── 🗂️ ui -│ ├── 🗂️ designsystem -├── 📁 data -│ ├── 🗂️ recordy -├── 📁 local -│ ├── 🗂️ recordy -├── 📁 remote -│ ├── 🗂️ recordy -├── 📁 domain -│ ├── 🗂️ recordy -├── 📁 feature +├── 📁:data +│ ├── 🗂️ auth +│ ├── 🗂️ keyword +│ ├── 🗂️ mypage +│ ├── 🗂️ oauth +│ ├── 🗂️ user +│ ├── 🗂️ video +├── 📁:local +│ ├── 🗂️ auth +│ ├── 🗂️ user +├── 📁:remote +│ ├── 🗂️ auth +│ ├── 🗂️ keyword +│ ├── 🗂️ user +│ ├── 🗂️ video +├── 📁:domain +│ ├── 🗂️ auth +│ ├── 🗂️ keyword +│ ├── 🗂️ oauth +│ ├── 🗂️ upload +│ ├── 🗂️ user +│ ├── 🗂️ video +├── 📁:feature │ ├── 🗂️ navigator │ ├── 🗂️ home │ ├── 🗂️ login @@ -83,6 +94,7 @@ │ ├── 🗂️ profile │ ├── 🗂️ upload │ ├── 🗂️ video -├── 📁 gradle +│ ├── 🗂️ setting +├── 📁:gradle │ ├── libs.versions.toml ```