docs : readme

README.md

@@ -1,3 +1,179 @@
-# Location-Based-Foodie-Service
+# 지리기반 맛집 추천 웹 서비스
 
-자리 기반 맛집 추천 웹 서비스
+<br/>
+
+## Table of Contents
+
+- [개요](#개요)
+- [Skils](#skils)
+- [Installation](#Installation)
+- [API Reference](#api-reference)
+- [프로젝트 진행 및 이슈 관리](#프로젝트-진행-및-이슈-관리)
+- [구현과정(설계 및 의도)](<#구현과정(설계-및-의도)>)
+- [TIL 및 회고](#til-및-회고)
+- [Authors](#authors)
+- [References](#references)
+
+<br/>
+
+## 개요
+
+본 서비스는 공공데이터를 활용하여, 지역 음식점 목록을 자동으로 업데이트 하고 이를 활용한다. 사용자 위치에맞게 맛집 및 메뉴를 추천하여 더 나은 다양한 음식 경험을 제공하고, 음식을 좋아하는 사람들 간의 소통과 공유를 촉진하려 합니다.
+
+**(내 위치 또는 지정한 위치 기반으로 식당 및 해당 맛집의 메뉴 를 추천한다)**
+
+
+## Skils
+
+<div align="center">
+
+언어 및 프레임워크 <br/> ![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens) ![SPRING](https://img.shields.io/badge/spring-6DA55F?style=for-the-badge&logo=spring&logoColor=white) ![JAVA](https://img.shields.io/badge/Java-007396?style=for-the-badge&logo=Java&logoColor=white)
+<br/>
+데이터 베이스 <br/>![Mysql](https://img.shields.io/badge/mysql-%23316192.svg?style=for-the-badge&logo=mysql&logoColor=white)<br/>
+
+</div>
+
+## Installation
+
+
+```bash
+  # 설치
+  git clone https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service.git
+
+  # 실행
+  ./gradlew build -x test
+
+  # 파일위치로 이동 후
+  javac LocationBasedFoodieServiceApplication.java
+```
+
+## Directory
+
+<details>
+<summary> 파일 구조 보기 </summary>
+
+```
+src
+├─common
+│  ├─config
+│  ├─dto
+│  ├─entity
+│  ├─error
+│  └─exception
+├─member
+│  ├─controller
+│  ├─dto
+│  ├─entity
+│  ├─repository
+│  └─service
+├─rawrestaurant
+│  ├─entity
+│  ├─repository
+│  └─scheduler
+├─restaurant
+│  ├─entity
+│  ├─repository
+│  └─scheduler
+├─review
+│  ├─controller
+│  ├─dto
+│  ├─entity
+│  ├─repository
+│  └─service
+├─sigungu
+│  ├─controller
+│  ├─dto
+│  ├─entity
+│  ├─repository
+│  └─service
+└─util
+    └─CustomResponseUtil
+```
+
+</details>
+<br/>
+
+## API Reference
+
+Swagger : http://localhost:{port}/swagger#/
+
+<details>
+
+<summary>Get all posts - click</summary>
+<img src="./public/fullApi.png" alt="logo" width="80%" />
+<img src="./public/posts.png" alt="logo" width="80%" />
+<img src="./public/posts_id.png" alt="logo" width="80%" />
+<img src="./public/posts_like.png" alt="logo" width="80%" />
+<img src="./public/posts_share.png" alt="logo" width="80%" />
+<img src="./public/statistics.png" alt="logo" width="80%" />
+<img src="./public/user_signup.png" alt="logo" width="80%" />
+<img src="./public/auth_login.png" alt="logo" width="80%" />
+<img src="./public/auth_verify.png" alt="logo" width="80%" />
+<img src="./public/auth_confirmcode.png" alt="logo" width="80%" />
+
+</details>
+
+<br/>
+
+## 프로젝트 진행 및 이슈 관리
+
+[![Notion](https://img.shields.io/badge/Notion-%23000000.svg?style=for-the-badge&logo=notion&logoColor=white)](https://www.notion.so/Team-Careerly-8d62334735154f7f9b9cbba91da21df5)
+
+[프로젝트 관리 페이지](https://www.notion.so/Team-Careerly-8d62334735154f7f9b9cbba91da21df5)
+
+<img src="./public/timeline.PNG" alt="logo" width="80%" />
+
+<br/>
+
+## 구현과정(설계 및 의도)
+
+<details>
+<summary>Post entity 설계 시 관계 설정 고려- click</summary>
+
+- **태그 관계**
+    1. 각 게시물은 여러 개의 해시태그를 포함할 수 있습니다.
+    2. 각 해시태그는 여러 게시물에 포함될 수 있습니다.
+    3. Post 엔터티와 Tag 엔터티 간의 다대다 관계를 @JoinTable post-tag 테이블을 통해 관리하여 검색과 분류에 용이하도록 설계했습니다.
+
+</details>
+
+<br/>
+
+## 코드리뷰 및 에러 해결
+
+### 로그인 회원가입
+- [로그인](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/13)
+- [회원가입](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/4)
+
+
+### 스케쥴러 데이터 파이프라인
+- [스케쥴러구현](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/25)
+- [데이터 파이프라인](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/33)
+
+### 맛집 평가
+- [맛집평가](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/15)
+- [맛집상세목록](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/35)
+
+### 맛집 목록
+- [맛집목록](https://github.com/Wanted-Internship-Team-Careerly/Location-Based-Foodie-Service/pull/23)
+
+<br/>
+
+## Authors
+
+<div align="center">
+
+<br/>
+
+![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white) </br>
+<a href="https://github.com/JisooPyo">표지수</a> <a href="https://github.com/9898s">김수환</a> <br/>
+<a href="https://github.com/dyori04">김정석</a> <a href="https://github.com/rivkode">이종훈</a>
+
+</div>
+<br/>
+
+## References
+
+- [Awesome Readme Templates](https://awesomeopensource.com/project/elangosundar/awesome-README-templates)
+- [Awesome README](https://github.com/matiassingers/awesome-readme)
+- [How to write a Good readme](https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project)