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] 리드미 수정 수정 #184

Merged
merged 3 commits into from
Nov 14, 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
95 changes: 80 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@
<img src="https://i.ibb.co/CVBQHPg/image-2.png" alt="메인 이미지" style="border: 2px solid black;">
</p>

## Table of Contents
> 1. [**_Project Purpose_**](#project-purpose)
> 2. [**_Service Info_**](#service-info)
> 3. [**_Main Function_**](#main-function)
> 4. [**_Development Focus Points_**](#development-focus-points)
> 5. [**_Repository Info_**](#repository-info)
> 6. [**_Development Term_**](#development-term)
> 7. [**_Deployment Link_**](#deployment-link)
> 8. [**_Contributor_**](#contributor)
> 9. [**_Program Architecture_**](#program-architecture)
> 10. [**_Main Dependency Version_**](#main-dependency-version)
> 11. [**_Tech Stack_**](#tech-stack)
> 12. [**_Example Usage_**](#example-usage)

## Project Purpose
> 저희의 아이디어는 **데이트 코스의 단조로움**을 어떻게 하면 해소할 수 있을까? 라는 생각에서 시작했습니다.
>
Expand All @@ -13,31 +27,82 @@
>
> 이를 관심있는 **인플루언서를 등록하고, 이에 따른 장소 추천 및, 장소에 대한 리뷰 기능**을 통해 풀어내어 **Inplace** 라는 저희만의 웹 애플리케이션으로 구현해보았습니다.

## Service Info
> 긴 영상은 필요 없어요 인플루언서가 다녀간 쿨플, 한눈에 쏙!
1. **회원 가입 및 로그인** 기능
- 카카오를 이용한 회원 가입 및 로그인
- 회원 닉네임 변경 가능
2. **관심있는 인플루언서 설정** 기능
- 최초 로그인 시, 관심 인플루언서를 설정 가능
- 이후, 인플루언서 페이지에서 좋아요 버튼을 통해 설정 가능
- 마이 페이지에서 관심있는 인플루언서 삭제 가능
3. **장소 검색 및 좋아요** 기능
- 지도를 통한 장소 검색 가능
- 지역, 인플루언서, 장소 태그를 통한 검색 가능
- 장소 세부 정보 열람 및 장소 좋아요 가능
4. **리뷰** 기능
- 장소에 대한 정보를 모바일로 받기 가능 ( 카카오톡 나에게 메세지 보내기 )
- 정보 받은 후 3일 뒤 리뷰 페이지 전송 ( 카카오톡 나에게 메세지 보내기 )

## Main Function
> 프로그램 시나리오
- 사용자 회원가입
- 사용자 로그인
- 관심있는 인플루언서 선택 ( 초기 한정 )
- 사용자 별 맞춤 페이지 제공 ( 좋아요 한 인플루언서의 영상, 내 주변 인플루언서 방문 장소에 대한 영상 )
- 인플루언서, 장소, 동영상 통합 검색 기능
- 인플루언서 검색 기능
- 인플루언서 좋아요 기능
- 지도를 통한 장소 검색 기능 ( 위치 정보, 인플루언서 정보, 장소 태그 별 검색 )
- 장소에 대한 상세 페이지 제공 기능 ( 장소 정보, 리뷰 정보 )
- 방문 예정 기능 ( 나에게 카카오 메세지 전송 )
- 방문 예정 이후 3일 뒤, 리뷰 기능 ( 나에게 카카오 메세지 전송 )
- 마이페이지 기능 ( 유저 별 좋아요 한 인플루언서, 장소와 리뷰 조회, 닉네임 변경 가능 )
> Inplace의 주요 기능
1. **회원가입 및 로그인**
- Spring Security를 이용한 OAuth 2.0 카카오 로그인 기능을 사용합니다
- 쿠키에 Access, Refresh Token을 담아 사용하며, Refresh 동작을 수행할 수 있습니다
2. **현재 위치 기반 서비스**
- 웹 페이지의 위치 정보 사용에 동의시, 카카오 API와 내 위치 정보를 사용하여 주변의 장소 정보와, 자동 지도 위치 설정을 사용할 수 있습니다
3. **통합 검색 서비스**
- Elastic Search를 사용한 인플루언서, 장소, 비디오 이름에 대한 통합 검색 기능을 사용할 수 있습니다
4. **관심 인플루언서 등록 및 이를 토대로 한 서비스**
- 최초 로그인 시 & 인플루언서 페이지에서 관심 인플루언서를 등록할 수 있습니다
- 이를 토대로 메인 페이지에서 관심 인플루언서의 최신 방문 장소를 확인할 수 있습니다
5. **지도 기반 검색 서비스**
- 지도 API를 이용하여 장소를 검색할 수 있습니다
- 관심 등록하지 않은 인플루언서 및 주소, 장소 태그를 이용하여 세부 검색이 가능합니다
6. **장소 세부 정보 서비스**
- 장소의 세부 정보를 열람할 수 있습니다
- 장소에 달린 다른 유저들의 리뷰를 확인할 수 있습니다
- 장소에 대한 좋아요 기능을 사용할 수 있습니다
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

카카오톡으로 장소 정보를 받을 수 있다고 해주세요.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수정 완료 👍

- 장소 세부 페이지에서 장소에 대한 정보를 카카오톡 메세지로 받아 볼 수 있습니다
7. **리뷰 기능**
- 장소 정보를 받은 후 3일 뒤, 해당 장소에 대한 리뷰 링크를 받아 리뷰를 작성할 수 있습니다
- 위 기능들은 카카오톡 메세지 보내기 API를 이용하며, 카카오톡으로 전송되는 링크는 모바일 뷰를 지원합니다
8. **마이 페이지 기능**
- 좋아요 표시한 장소, 인플루언서를 관리할 수 있습니다
- 내가 작성한 리뷰를 관리할 수 있습니다
- 사용자 닉네임을 변경할 수 있습니다

## Development Focus Points

## Repository Info
> **Using Language**
>
![GitHub language count](https://img.shields.io/github/languages/count/kakao-tech-campus-2nd-step3/Team7_BE)
![GitHub top language](https://img.shields.io/github/languages/top/kakao-tech-campus-2nd-step3/Team7_BE)

> **Repo, Code Volume**
>
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/kakao-tech-campus-2nd-step3/Team7_BE)
![GitHub repo size](https://img.shields.io/github/repo-size/kakao-tech-campus-2nd-step3/Team7_BE)

> **Commit Avg**
>
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/kakao-tech-campus-2nd-step3/Team7_BE)

> **Issues**
>
![GitHub open issues](https://img.shields.io/github/issues/kakao-tech-campus-2nd-step3/Team7_BE)
![GitHub closed issues](https://img.shields.io/github/issues-closed/kakao-tech-campus-2nd-step3/Team7_BE)
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/kakao-tech-campus-2nd-step3/Team7_BE)

## Deploy Link
> **PRs**
>
![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)

## Development Term
> 2024.08.22 ~ 2024.11.15

## Deployment Link
> [**BackEnd**](https://api.inplace.my) : _api.inplace.my_
>
> [**API Spec**](https://api.inplace.my/swagger-ui/index.html) : _api.inplace.my/swagger-ui/index.html_
Expand Down