From 71d7f17586d4a91be6b0ae7c78a917d1868be303 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=EB=82=98=EC=84=B8=EB=B9=88?=
<94737768+sebbbin@users.noreply.github.com>
Date: Tue, 9 Jul 2024 09:25:53 +0900
Subject: [PATCH] [docs] README.md
---
README.md | 144 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 142 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 2b489521..5c3e8da5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,142 @@
-# Recordy-Server
-레코디레코디 잉잉
+
+
+
+## 🌊 유영
+**유저가 ‘공간’을 ‘영상’으로 디깅하고, 나만의 ‘공간 취향’을 발견하는 서비스**
+
+## 🔢 목차
+[프로젝트 설명](#프로젝트-설명)
+[팀원](#팀원)
+[Git Flow](#Git-Flow)
+[ERD](#ERD)
+[폴더링](#폴더링)
+[레코디 컨벤션 및 API docs](#레코디 컨벤션 및 API docs)
+[폴더링](#폴더링)
+
+## 🅿️ 프로젝트 설명
+
+### 🪼 우리가 해결하고자 하는 문제
+**- 취향에 맞는 공간 정보를 받을 수 있는 플랫폼의 분산**
+**- 공간감을 느낄 수 없는 가공된 사진**
+**- 기존 플랫폼의 영상 알고리즘으로 내 취향에 맞지 않는 공간 노출**
+
+### 📔 해결책
+**- 내 취향에 맞는 공간을 영상을 통해 향유할 수 있는 서비스가 필요**
+
+### 🙋♀️ 타겟
+**-공간을 좋아하는 1020 유저. 자신의 취향이 뚜렷한 유저**
+
+### 🧩 우리의 서비스
+**-유저가 ‘공간’을 ‘영상’으로 디깅하고, 나만의 ‘공간 취향’을 발견하는 서비스**
+
+### 🔑 핵심 키워드
+### '취향' '공간' '영상'
+
+### 🏅 기능 우선순위 3가지 (MVP에서 가져갈 기능)
+**- 영상 업로드**
+**- 취향 키워드칩 선택**
+**- 타 유저 영상 시청 후 북마크**
+
+
+
+## 👤 팀원
+|
|
|
|
+|:---------:|:---------:|:---------:|
+|[나세빈](https://github.com/sebbbin)|[박수빈](https://github.com/elive7)|[진건우](https://github.com/jinkonu)|
+| `나세빈` | `박수빈` | `👑 진건우` |
+
+
+## 🐬 Git Flow
+
+
+| 브랜치 명 | 설명 |
+| :-------: | :--------------------------------------------------------------------------------- |
+| main | 소프트웨어 제품 배포하는 용도로 쓰는 브랜치 |
+| develop | 개발용 default 브랜치로, 이 브랜치를 기준으로 feature 브랜치를 따고, 합치는 브랜치 |
+| feat | 단위 기능 개발용 브랜치 |
+| fix | 단위 기능 개발 수정용 브랜치 |
+| hotfix | master에 배포 코드가 합쳐진 후 버그 발생 시 긴급 수정하는 브랜치 |
+
+### **📌 Branch**
+
+- 깃플로우에 따라 기능별로 브랜치 생성
+- 형식: `브랜치 명/#이슈번호`
+
+
+## 🛠️ Architecture
+
+
+## 🌱 ERD
+
+
+
+## ❗ 레코디 컨벤션 및 API docs
+**레코디 컨벤션 및 협업 규칙:** [Git Convention](https://bohyunnkim.notion.site/0c9e0fe52b204329a7a927e05c125c16?pvs=4)
+**API docs:** [API docs](https://www.notion.so/bohyunnkim/API-Docs-365270d3fb184ac0b3599dc28be5337d)
+
+## 🗂️ 폴더링
+```
+.
+├── build
+│ ├── classes
+│ │ └── java
+│ │ ├── main
+│ │ │ └── org
+│ │ │ └── recordy
+│ │ │ └── server
+│ │ │ ├── 📁 auth
+│ │ │ │ ├── domain
+│ │ │ │ ├── exception
+│ │ │ │ ├── repository
+│ │ │ │ │ └── impl
+│ │ │ │ ├── security
+│ │ │ │ │ └── handler
+│ │ │ │ └── service
+│ │ │ │ ├── dto
+│ │ │ │ └── impl
+│ │ │ │ ├── apple
+│ │ │ │ ├── kakao
+│ │ │ │ └── token
+│ │ │ ├── 📁 common
+│ │ │ │ ├── config
+│ │ │ │ ├── domain
+│ │ │ │ ├── dto
+│ │ │ │ │ └── response
+│ │ │ │ ├── exception
+│ │ │ │ ├── handler
+│ │ │ │ ├── message
+│ │ │ │ └── util
+│ │ │ ├── 📁 external
+│ │ │ ├── 📁 keyword
+│ │ │ ├── 📁 record
+│ │ │ ├── 📁 record_stat
+│ │ │ └── 📁 user
+│ │ │ ├── controller
+│ │ │ │ └── dto
+│ │ │ │ ├── request
+│ │ │ │ └── response
+│ │ │ ├── domain
+│ │ │ │ └── usecase
+│ │ │ ├── exception
+│ │ │ ├── repository
+│ │ │ │ └── impl
+│ │ │ └── service
+│ │ │ └── impl
+│ │ └── test
+│ │ └── org
+│ │ └── recordy
+│ │ └── server
+│ │ ├── 📁 auth
+│ │ ├── 📁 common
+│ │ ├── 📁 external
+│ │ ├── 📁 keyword
+│ │ ├── 📁 mock
+│ │ │ ├── auth
+│ │ │ ├── keyword
+│ │ │ ├── record
+│ │ │ └── user
+│ │ ├── 📁 record
+│ │ ├── 📁 user
+│ │ └── 📁 util
+```
+