Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] readme 파일 수정 #224

Merged
merged 2 commits into from
Nov 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 58 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,42 @@

# 목차

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 [**사용 예시**](#-사용-예시)

# 📝 프로젝트 개요

---

# 프로젝트 개요

## 🙌프로젝트 목적
## 🙌 프로젝트 목적

> 저희의 아이디어는 **데이트 코스의 단조로움**을 어떻게 하면 해소할 수 있을까? 💡 라는 생각에서 시작했습니다.
>
Expand All @@ -46,7 +53,7 @@
> 이를 통해 사용자가 관심있는 **인플루언서를 등록하고, 이에 따른 장소 추천 및, 장소에 대한 리뷰 기능** 📋을 제공하여, **Inplace** 라는 저희만의 웹
> 애플리케이션으로 구현해보았습니다.

## 서비스 정보
## 📋 서비스 정보

> 긴 영상은 필요 없어요 인플루언서가 다녀간 쿨플, 한눈에 쏙!

Expand Down Expand Up @@ -76,19 +83,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)

Expand All @@ -98,15 +105,15 @@

- [🙋‍♂️ Visit Team7 ERD](https://www.notion.so/ERD-36ec8e40cb264abe87588e97ae77ac55)

---
# 👨‍💻 개발 정보

# 개발 정보
---

## 개발 기간
## 📅 개발 기간

> **_2024.08.22 ~ 2024.11.15_**

## 팀원
## 👥 팀원

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<table>
Expand Down Expand Up @@ -165,7 +172,7 @@
</table>
<!-- ALL-CONTRIBUTORS-LIST:END -->

## 저장소 정보
## 📂 저장소 정보

> **Using Language**
>
Expand All @@ -191,17 +198,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**
>
Expand Down Expand Up @@ -252,19 +259,20 @@
![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)

---

# 테스트
# ✅ 테스트

---

> **테스트 시나리오** : https://www.notion.so/9ed68b292c004fc69f7eaad513054d96
>
> **테스트 결과보고서** : https://www.notion.so/08a520d3b8c44154a19425b0bcc16f6f

---
# 🎬 기능 및 사용 예시

# 기능 및 사용 예시
---

## 세부 기능 흐름
## 🔍 세부 기능 흐름

- ### Spring Security
- oauth 로그인 시, jwt로 accessToken과 refreshToken을 Cookie에 담아줍니다.
Expand All @@ -275,7 +283,6 @@
- 3일 뒤 나에게 보내기 kakao api를 통해 리뷰 요청 메세지를 보냅니다.
- ### TokenRefresh
- Redis DB에 username(key)로 refreshToken을 확인하고, RTR (Refresh Token Rotation)을 합니다.

- ### Influencer
- 로그인 상태인 경우 사용자가 좋아요한 인플루언서를 먼저 반환합니다.
- ### FavoriteInfluencer
Expand All @@ -287,7 +294,10 @@
- 내가 작성한 리뷰 조회 시 장소 정보 일부를 함께 반환합니다.
- ### Place
- 내가 좋아요한 장소 조회 시 인플루언서 정보 일부를 함께 반환합니다.
- ### Video
- 로그인 상태인 경우 사용자가 좋아요한 인플루언서의 동영상, 사용자 주변 장소의 동영상을 반환합니다.
- 로그인 상태가 아닌 경우 조회수 증가량이 높은 동영상, 새로운 동영상을 반환합니다.

## 사용 예시
## 📱 사용 예시

> 실제 유저 사용 페이지 흐름 보여주기 ( 영상 x )