From b5a9abcaf13b138423e8a918b0d7ead7e07e2f4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EB=B0=B0=EC=A4=80=ED=98=B8?= <114082026+BaeJunH0@users.noreply.github.com> Date: Fri, 15 Nov 2024 14:59:20 +0900 Subject: [PATCH] =?UTF-8?q?[docs]=20readme=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 video 기능 흐름 추가, 목차 형식 변경, 이모지 삽입 --- README.md | 95 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 53 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 7c84cad1..e56637a7 100644 --- a/README.md +++ b/README.md @@ -6,31 +6,40 @@ ## 목차 -1. [**프로젝트 개요**](#프로젝트-개요) - - 1.1 [**프로젝트 목적**](#프로젝트-목적) - - 1.2 [**서비스 정보**](#서비스-정보) - - 1.3 [**배포 주소**](#배포-주소) - -2. [**프로그램 구조**](#프로그램-구조) - - 2.1 [**프로그램 구조도**](#프로그램-구조도) - - 2.2 [**API & ERD**](#api--erd) - -3. [**개발 정보**](#개발-정보) - - 3.1 [**개발 기간**](#개발-기간) - - 3.2 [**팀원**](#팀원) - - 3.3 [**저장소 정보**](#저장소-정보) - -4. [**기술 정보**](#기술-정보) - - 4.1 [**주요 종속성 버전**](#주요-종속성-버전) - - 4.2 [**기술 스택**](#기술-스택) - -5. [**테스트**](#테스트) - -6. [**기능 및 사용 예시**](#기능-및-사용-예시) - - 6.1 [**세부 기능 흐름**](#세부-기능-흐름) - - 6.2 [**사용 예시**](#사용-예시) - -## 🙌프로젝트 목적 +1. [**프로젝트 개요**](#-프로젝트-개요) + > 1.1 [**프로젝트 목적**](#-프로젝트-목적) + > + > 1.2 [**서비스 정보**](#-서비스-정보) + > + > 1.3 [**배포 주소**](#-배포-주소) + +2. [**프로그램 구조**](#%EF%B8%8F-프로그램-구조) + > 2.1 [**프로그램 구조도**](#%EF%B8%8F-프로그램-구조도) + > + > 2.2 [**API & ERD**](#-api--erd) + +3. [**개발 정보**](#-개발-정보) + > 3.1 [**개발 기간**](#-개발-기간) + > + > 3.2 [**팀원**](#-팀원) + > + > 3.3 [**저장소 정보**](#-저장소-정보) + +4. [**기술 정보**](#%EF%B8%8F-기술-정보) + > 4.1 [**주요 종속성 버전**](#-주요-종속성-버전) + > + > 4.2 [**기술 스택**](#-기술-스택) + +5. [**테스트**](#-테스트) + +6. [**기능 및 사용 예시**](#-기능-및-사용-예시) + > 6.1 [**세부 기능 흐름**](#-세부-기능-흐름) + > + > 6.2 [**사용 예시**](#-사용-예시) + +## 📝 프로젝트 개요 + +## 🙌 프로젝트 목적 > 저희의 아이디어는 **데이트 코스의 단조로움**을 어떻게 하면 해소할 수 있을까? 라는 생각에서 시작했습니다. > @@ -42,7 +51,7 @@ > 이를 관심있는 **인플루언서를 등록하고, 이에 따른 장소 추천 및, 장소에 대한 리뷰 기능**을 통해 풀어내어 **Inplace** 라는 저희만의 웹 애플리케이션으로 > 구현해보았습니다. -## 서비스 정보 +## 📋 서비스 정보 > 긴 영상은 필요 없어요 인플루언서가 다녀간 쿨플, 한눈에 쏙! @@ -72,19 +81,19 @@ - 내가 작성한 리뷰를 관리할 수 있습니다 - 사용자 닉네임을 변경할 수 있습니다 -## 배포 주소 +## 🌐 배포 주소 > **BackEnd** : [**_api.inplace.my_**](https://api.inplace.my) > > **FrontEnd**: [**_inplace.my_**](https://inplace.my) -## 프로그램 구조 +## 🏗️ 프로그램 구조 --- -## 프로그램 구조도 +## 🖼️ 프로그램 구조도 -## API & ERD +## 📊 API & ERD ![image](https://github.com/user-attachments/assets/ce11ff39-8294-4eda-aa58-7b5bd0ac1620) @@ -94,15 +103,15 @@ - [🙋‍♂️ Visit Team7 ERD](https://www.notion.so/ERD-36ec8e40cb264abe87588e97ae77ac55) -## 개발 정보 +## 👨‍💻 개발 정보 --- -## 개발 기간 +## 📅 개발 기간 > **_2024.08.22 ~ 2024.11.15_** -## 팀원 +## 👥 팀원 @@ -161,7 +170,7 @@
-## 저장소 정보 +## 📂 저장소 정보 > **Using Language** > @@ -187,17 +196,17 @@ ![GitHub pull requests](https://img.shields.io/github/issues-pr/kakao-tech-campus-2nd-step3/Team7_BE?label=open%20pull%20requests) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/kakao-tech-campus-2nd-step3/Team7_BE?label=closed%20pull%20requests) -## 기술 정보 +## 🛠️ 기술 정보 --- -## 주요 종속성 버전 +## 🧩 주요 종속성 버전 > **Spring Boots 3.3.3** > > **Java 17 LTS** -## 기술 스택 +## 🚀 기술 스택 > **Backend** > @@ -248,7 +257,7 @@ ![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat-square&logo=discord&logoColor=white) ![Slack](https://img.shields.io/badge/Slack-4A154B?style=flat-square&logo=slack&logoColor=white) -## 테스트 +## ✅ 테스트 --- @@ -256,11 +265,11 @@ > > **테스트 결과보고서** : https://www.notion.so/08a520d3b8c44154a19425b0bcc16f6f -## 기능 및 사용 예시 +## 🎬 기능 및 사용 예시 --- -## 세부 기능 흐름 +## 🔍 세부 기능 흐름 - ### Spring Security - oauth 로그인 시, jwt로 accessToken과 refreshToken을 Cookie에 담아줍니다. @@ -271,7 +280,6 @@ - 3일 뒤 나에게 보내기 kakao api를 통해 리뷰 요청 메세지를 보냅니다. - ### TokenRefresh - Redis DB에 username(key)로 refreshToken을 확인하고, RTR (Refresh Token Rotation)을 합니다. - - ### Influencer - 로그인 상태인 경우 사용자가 좋아요한 인플루언서를 먼저 반환합니다. - ### FavoriteInfluencer @@ -283,7 +291,10 @@ - 내가 작성한 리뷰 조회 시 장소 정보 일부를 함께 반환합니다. - ### Place - 내가 좋아요한 장소 조회 시 인플루언서 정보 일부를 함께 반환합니다. +- ### Video + - 로그인 상태인 경우 사용자가 좋아요한 인플루언서의 동영상, 사용자 주변 장소의 동영상을 반환합니다. + - 로그인 상태가 아닌 경우 조회수 증가량이 높은 동영상, 새로운 동영상을 반환합니다. -## 사용 예시 +## 📱 사용 예시 > 실제 유저 사용 페이지 흐름 보여주기 ( 영상 x )