From 7e064e93ba1d753375342364333afd26b4660533 Mon Sep 17 00:00:00 2001
From: SuHyunKKim <kimsteven728@dgu.ac.kr>
Date: Sun, 15 Dec 2024 11:56:09 +0900
Subject: [PATCH] docs:[ALL] README.md modify ing

---
 .idea/modules/server.main.iml |   8 --
 README.md                     | 193 +++++++++++++++++++++++-----------
 2 files changed, 132 insertions(+), 69 deletions(-)
 delete mode 100644 .idea/modules/server.main.iml

diff --git a/.idea/modules/server.main.iml b/.idea/modules/server.main.iml
deleted file mode 100644
index 0c8f1ab4..00000000
--- a/.idea/modules/server.main.iml
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module version="4">
-  <component name="AdditionalModuleElements">
-    <content url="file://$MODULE_DIR$/../../server/build/generated/sources/annotationProcessor/java/main">
-      <sourceFolder url="file://$MODULE_DIR$/../../server/build/generated/sources/annotationProcessor/java/main" isTestSource="false" generated="true" />
-    </content>
-  </component>
-</module>
\ No newline at end of file
diff --git a/README.md b/README.md
index ca7f762b..c1b4038b 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,28 @@
 # πŸŠλ‹Ήμ‹ μ˜ μ œμ£Όλ„ 여행을 탐라, νƒλ‚˜μ™€ ν•¨κ»˜.
+---
 ![Group 64746](https://github.com/user-attachments/assets/c1597f72-1208-46fd-aca1-7857fe7dbd13)
 
 
 
 ## λͺ©μ°¨
-[1. νŒ€μ›](#🀝-νŒ€μ›)<br>
-[2. ν”„λ‘œμ νŠΈ μ†Œκ°œ](#🍊-ν”„λ‘œμ νŠΈ-μ†Œκ°œ-🍊)<br>
-&nbsp;&nbsp;&nbsp;&nbsp;[2.1. μ£Όμš” ν™”λ©΄ ꡬ성](#πŸ–₯️-μ£Όμš”-ν™”λ©΄-ꡬ성)<br>
-&nbsp;&nbsp;&nbsp;&nbsp;[2.2. ν”„λ‘œμ νŠΈ ꡬ쑰](#πŸ“‚-ν”„λ‘œμ νŠΈ-ꡬ쑰)<br>
-&nbsp;&nbsp;&nbsp;&nbsp;[2.3. 기술 μŠ€νƒ](#πŸ› οΈ-기술-μŠ€νƒ)<br>
-[3. ν˜‘μ—… κ·œμΉ™](#ν˜‘μ—…-κ·œμΉ™)<br>
-[4. μΆ”κ°€μžλ£Œ](#μΆ”κ°€μžλ£Œ)<br>
+---
+[1. νŒ€μ›](#-🀝-νŒ€μ›)
+[2. ν”„λ‘œμ νŠΈ μ†Œκ°œ](#-🍊-ν”„λ‘œμ νŠΈ-μ†Œκ°œ-🍊)
+&nbsp;&nbsp;&nbsp;&nbsp;[2.1. μ£Όμš” ν™”λ©΄ ꡬ성](#-πŸ–₯️-μ£Όμš”-ν™”λ©΄-ꡬ성)
+&nbsp;&nbsp;&nbsp;&nbsp;[2.2. ν”„λ‘œμ νŠΈ ꡬ쑰](#-πŸ“‚-ν”„λ‘œμ νŠΈ-ꡬ쑰)
+&nbsp;&nbsp;&nbsp;&nbsp;[2.3. 기술 μŠ€νƒ](#-πŸ› οΈ-기술-μŠ€νƒ)
+[3. ν˜‘μ—… κ·œμΉ™](#ν˜‘μ—…-κ·œμΉ™)
+[4. μ‹œμž‘ κ°€μ΄λ“œ](#μ‹œμž‘-κ°€μ΄λ“œ)
+[5. μΆ”κ°€ 자료](#μΆ”κ°€μžλ£Œ)
 <br><br>
 
 ## 🀝 νŒ€μ›
-
+---
 |<img src="https://avatars.githubusercontent.com/u/144208568?v=4" width="150" height="150"/>|<img src="https://avatars.githubusercontent.com/u/155754445?v=4" width="150" height="150"/>|<img src="https://avatars.githubusercontent.com/u/162420581?v=4" width="150" height="150"/>|<img src="https://avatars.githubusercontent.com/u/144078388?v=4" width="150" height="150"/>|
 |:-:|:-:|:-:|:-:|
 |κΉ€μˆ˜ν˜„[@SuHyunKKim](https://github.com/SuHyunKKim) |μ„œκ°€μ€[@gaaaani](https://github.com/gaaaani)|μ΄ν˜„μ’…[@HyunJong00](https://github.com/HyunJong00)|쑰예림[@YeRimmm-Cho](https://github.com/YeRimmm-Cho)|
 |λ°±μ—”λ“œ |λ°±μ—”λ“œ |ν”„λ‘ νŠΈμ—”λ“œ |ν”„λ‘ νŠΈμ—”λ“œ |
 
-<br>
 
 ꡬ뢄 | μ„±λͺ… | ν•™λ²ˆ | μ†Œμ†ν•™κ³Ό | 연계전곡
 ------|-------|-------|-------|-------
@@ -28,23 +30,24 @@
 νŒ€μ› | μ„œκ°€μ€ | 2021110261 | 톡계학과 | μœ΅ν•©μ†Œν”„νŠΈμ›¨μ–΄      
 νŒ€μ› | μ΄ν˜„μ’… | 2019111655 | λ°”μ΄μ˜€ν™˜κ²½κ³Όν•™κ³Ό | μœ΅ν•©μ†Œν”„νŠΈμ›¨μ–΄ 
 νŒ€μ› | 쑰예림 | 2020111500 | νšŒκ³„ν•™κ³Ό | μœ΅ν•©μ†Œν”„νŠΈμ›¨μ–΄ 
-<br>
 
-## 🍊 ν”„λ‘œμ νŠΈ μ†Œκ°œ 🍊
+<br><br>
+
 
-### 🍊 LLM 기반 μ œμ£Όλ„ μ—¬ν–‰ κ³„νš μΆ”μ²œ μ„œλΉ„μŠ€ "탐라, νƒλ‚˜"
-- LLMκ³Ό RAGλ₯Ό κ²°ν•˜μ—¬ μ œμ£Όλ„λ₯Ό μ—¬ν–‰ν•˜λŠ” μ‚¬μš©μžλ“€μ΄ 개인의 μ·¨ν–₯κ³Ό ν•„μš”μ— 맞좘 μ—¬ν–‰ κ³„νšμ„ μ‰½κ²Œ μ„Έμš°κ³  μ‹€ν–‰ν•  수 μžˆλ„λ‘ λ•λŠ” ν”Œλž«νΌ 개발<br><br>
 
+## 🍊 ν”„λ‘œμ νŠΈ μ†Œκ°œ 🍊
+---
+### 🍊 LLM 기반 μ œμ£Όλ„ μ—¬ν–‰ κ³„νš μΆ”μ²œ μ„œλΉ„μŠ€ "탐라, νƒλ‚˜"
+- LLMκ³Ό RAGλ₯Ό κ²°ν•˜μ—¬ μ œμ£Όλ„λ₯Ό μ—¬ν–‰ν•˜λŠ” μ‚¬μš©μžλ“€μ΄ 개인의 μ·¨ν–₯κ³Ό ν•„μš”μ— 맞좘 μ—¬ν–‰ κ³„νšμ„ μ‰½κ²Œ μ„Έμš°κ³  μ‹€ν–‰ν•  수 μžˆλ„λ‘ λ•λŠ” ν”Œλž«νΌ 개발<br>
 ### 🍊 개발λͺ©ν‘œ
 - μ‚¬μš©μž μ€‘μ‹¬μ˜ λ§žμΆ€ν˜• μ—¬ν–‰ 일정 μΆ”μ²œ μ„œλΉ„μŠ€ 제곡
 - μ—¬ν–‰ 일정 κ΄€λ¦¬μ˜ νŽΈμ˜μ„± 제곡
-- μ΅œμ‹  데이터와 LLM의 κ²°ν•©μœΌλ‘œ 신뒰도 κ°•ν™”<br><br>
+- μ΅œμ‹  데이터와 LLM의 κ²°ν•©μœΌλ‘œ 신뒰도 κ°•ν™”<br>
 
 ### 🍊 μ£Όμš” κΈ°λŠ₯
 - **μ‚¬μš©μž λ§žμΆ€ν˜• μ—¬ν–‰ μΆ”μ²œ**
   - μ‚¬μš©μžκ°€ μž…λ ₯ν•œ μ—¬ν–‰ 정보(μ—¬ν–‰ κΈ°κ°„, λ™λ°˜μž, μ„ ν˜Έ ν…Œλ§ˆ λ“±)λ₯Ό λ°”νƒ•μœΌλ‘œ 페λ₯΄μ†Œλ‚˜κ°€ λΆ€μ—¬λœ LLM이 μ—¬ν–‰ 일정을 μΆ”μ²œ
   - μ‹€μ‹œκ°„ λŒ€ν™”ν˜• μΈν„°νŽ˜μ΄μŠ€λ₯Ό 톡해 μΆ”μ²œλ°›μ€ 일정 μˆ˜μ • 및 μƒν˜Έμž‘μš© κ°€λŠ₯<br><br>
-
 - **RAG(Retrieval-Augmented Generation) 기반 μž₯μ†Œ 데이터 ν™œμš©**
   - ν¬λ‘€λ§ν•œ 데이터λ₯Ό 기반으둜 ν•œ μ΅œμ‹  μž₯μ†Œ 정보 제곡
   - RAG κΈ°μˆ μ„ μ‚¬μš©ν•˜μ—¬ λ°μ΄ν„°λ² μ΄μŠ€μ—μ„œ κ΄€λ ¨ 정보λ₯Ό κ²€μƒ‰ν•˜κ³  LLM이 μžμ—°μ–΄λ‘œ μ—¬ν–‰ 일정 생성<br><br>
@@ -54,12 +57,10 @@
 
 - **μ—¬ν–‰ 일정 μ €μž₯ 및 관리**
   - μƒμ„±λœ μ—¬ν–‰ 일정을 μ‚¬μš©μžκ°€ μ €μž₯ν•  수 μžˆλŠ” κΈ°λŠ₯ 지원
-  - μ €μž₯된 일정을 μ‚¬μš©μžκ°€ μ–Έμ œλ“  λ‹€μ‹œ 확인 κ°€λŠ₯
-
-<br><br>
+  - μ €μž₯된 일정을 μ‚¬μš©μžκ°€ μ–Έμ œλ“  λ‹€μ‹œ 확인 κ°€λŠ₯<br><br>
 
 ## πŸ–₯️ μ£Όμš” ν™”λ©΄ ꡬ성
-
+---
 <table>
   <tr>
     <th>μ‚¬μš©μž 초기 μž…λ ₯ ν™”λ©΄</th>
@@ -89,63 +90,72 @@
 
 <br>
 
+#### βœ”οΈμ‹œμ—° μ˜μƒ 링크
 πŸ”— [**μ‹œμ—° λ™μ˜μƒ 링크**](https://youtu.be/xXba5srjkrQ)
 
 <br><br>
+<div align="right">
+
+[λͺ©μ°¨λ‘œ](#λͺ©μ°¨)
+
+</div>
 
 ## πŸ“‚ ν”„λ‘œμ νŠΈ ꡬ쑰
+---
 ### βœ”οΈBack-end
 ```
 2024-2-SCS4031-jjambbong-3
-β”œβ”€β”€ .github
-β”œβ”€β”€ .idea
-β”œβ”€β”€ .vscode
-β”œβ”€β”€ frontend
+β”œβ”€β”€ agentPersona           # LLM λͺ¨λΈ 디렉토리
+β”‚   β”œβ”€β”€ tamtam             # ν”„λ‘¬ν”„νŠΈ ν…œν”Œλ¦Ώ, ai api, μ‹€ν—˜ 폴더
+β”‚   β”œβ”€β”€ venv               # 이 λ£¨νŠΈμ— κ°€μƒν™˜κ²½ 생성
+β”‚   β”œβ”€β”€ app4.py            # 메인 flask μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜
+β”‚   β”œβ”€β”€ requirements.txt
+β”‚   β”œβ”€β”€ .env
 β”œβ”€β”€ server
 β”‚   β”œβ”€β”€ src
 β”‚   β”‚   β”œβ”€β”€ main
-β”‚   β”‚   β”‚   β”œβ”€β”€ java.com.capstone.server
-β”‚   β”‚   β”‚   β”‚ 
-β”‚   β”‚   β”‚   β”œβ”€β”€ python
-β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ app.py
-β”‚   β”‚   β”‚   β”œβ”€β”€ resources
-β”œβ”€β”€ PinecornDB
-β”œβ”€β”€ venv
-β”œβ”€β”€ README.md
-β”œβ”€β”€ requirements.txt
-β”œβ”€β”€ .env
-
-
+β”‚   β”‚   β”‚   β”œβ”€β”€ java.com.capstone.server  # μŠ€ν”„λ§λΆ€νŠΈ λͺ¨λ“ˆ 파일 폴더
+β”‚   β”‚   β”‚   β”œβ”€β”€ resources  # μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ properties
+β”‚   β”œβ”€β”€ build.gradle       # gradle λΉŒλ“œ 파일
+β”œβ”€β”€ data
+β”‚   β”œβ”€β”€ testdb.sqlite      # ν”„λ‘œμ νŠΈ DB
 ```
 ### βœ”οΈFront-end
 ```
 frontend
- ┣ node_modules
- ┣ public
- ┃ ┣ mockdata
- ┃ ┣ favicon.ico
- ┃ ┣ index.html
- ┃ ┣ logo.svg
- ┃ β”— manifest.json
- ┣ src
- ┃ ┣ api        # API μ—°κ²° μ½”λ“œ λͺ¨μŒ
- ┃ ┣ assets     # μ‚¬μš© 이미지 및 μ•„μ΄μ½˜ λͺ¨μŒ
- ┃ ┃ ┣ fonts    # μ‚¬μš© 폰트
- ┃ ┃ ┣ images
- ┃ ┃ β”— logo.svg
- ┃ ┣ components		  # μž¬μ‚¬μš© κ°€λŠ₯ μ»΄ν¬λ„ŒνŠΈ λͺ¨μŒ
- ┃ ┣ pages	        # νŽ˜μ΄μ§€ λͺ¨μŒ
- ┃ ┣ App.js
- ┃ ┣ index.js
- ┃ ┣ setupProxy.js
- ┃ β”— url.txt
- ┣ .gitignore
- ┣ package-lock.json
- ┣ package.json
- β”— yarn.lock
+β”œβ”€β”€ node_modules
+β”œβ”€β”€ public
+β”‚   β”œβ”€β”€ mockdata
+β”‚   β”œβ”€β”€ favicon.ico
+β”‚   β”œβ”€β”€ index.html
+β”‚   β”œβ”€β”€ logo.svg
+β”‚   β”œβ”€β”€ manifest.json
+β”œβ”€β”€ src
+β”‚   β”œβ”€β”€ api             # API μ—°κ²° μ½”λ“œ λͺ¨μŒ
+β”‚   β”œβ”€β”€ assets          # μ‚¬μš© 이미지 및 μ•„μ΄μ½˜ λͺ¨μŒ
+β”‚   β”‚   β”œβ”€β”€ fonts       # μ‚¬μš© 폰트
+β”‚   β”‚   β”œβ”€β”€ images
+β”‚   β”‚   β”œβ”€β”€ logo.svg
+β”‚   β”œβ”€β”€ components		# μž¬μ‚¬μš© κ°€λŠ₯ μ»΄ν¬λ„ŒνŠΈ λͺ¨μŒ
+β”‚   β”œβ”€β”€ pages	        # νŽ˜μ΄μ§€ λͺ¨μŒ
+β”‚   β”œβ”€β”€ App.js
+β”‚   β”œβ”€β”€ index.js
+β”‚   β”œβ”€β”€ setupProxy.js
+β”‚   β”œβ”€β”€ url.txt
+β”œβ”€β”€ .gitignore
+β”œβ”€β”€ package-lock.json
+β”œβ”€β”€ package.json
+β”œβ”€β”€ yarn.lock
 ```
-<br><br>
+<br>
+<div align="right">
+
+[λͺ©μ°¨λ‘œ](#λͺ©μ°¨)
+
+</div>
+
 ## πŸ› οΈ 기술 μŠ€νƒ
+---
 <div style="display:flex; flex-direction:column; align-items:flex-start;">
     <!-- Frontend -->
     <p><strong>Frontend</strong></p>
@@ -217,9 +227,14 @@ frontend
       <img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white">
     </div>
 </div>
+<br>
+<div align="right">
 
+[λͺ©μ°¨λ‘œ](#λͺ©μ°¨)
+</div>
 
 ## ν˜‘μ—… κ·œμΉ™
+---
 ### 🍊Branch κ·œμΉ™
 - 메인 λΈŒλžœμΉ˜μ™€ κΈ°λŠ₯별 브랜치λ₯Ό κ΅¬λΆ„ν•˜μ—¬ μ‚¬μš©
 - `main`: 배포 κ°€λŠ₯ν•œ μƒνƒœμ˜ μ½”λ“œλ§Œμ„ κ΄€λ¦¬ν•˜λŠ” 브랜치
@@ -250,8 +265,59 @@ frontend
 ### 🍊Issue κ·œμΉ™
 - ν…œν”Œλ¦Ώμ„ μ‚¬μš©ν•˜μ—¬ Issueλ₯Ό μž‘μ„±: [Issue ν…œν”Œλ¦Ώ λ°”λ‘œκ°€κΈ°](https://github.com/CSID-DGU/2024-2-SCS4031-jjambbong-3/tree/main/.github/ISSUE_TEMPLATE)
 - PR에 ν•΄λ‹Ήν•˜λŠ” 이슈번호λ₯Ό μž‘μ„±ν•˜μ—¬ PRκ³Ό 이슈λ₯Ό μ—°κ²°
+<br>
+<div align="right">
+
+[λͺ©μ°¨λ‘œ](#λͺ©μ°¨)
 
+</div>
 
+## μ‹œμž‘ κ°€μ΄λ“œ
+---
+### Requirements
+둜컬 ν™˜κ²½μ—μ„œ λΉŒλ“œν•˜κ³  μ‹€ν–‰ν•˜λ €λ©΄ λ‹€μŒμ΄ ν•„μš”ν•¨:
+```
+* Intellij - for Springboot
+* Ngrok
+* Front, Back .env 파일 (μš”μ²­μ‹œ 제곡)
+```
+
+### μ‹€ν–‰ 방법
+- Springboot, flask, react 총 3개의 ν”„λ‘œμ νŠΈλ₯Ό 싀행해야함
+- Intellij μƒμ—μ„œ λ¦¬μ—‘νŠΈμ™€ ν”ŒλΌμŠ€ν¬λ₯Ό μœ„ν•œ λ‘κ°œμ˜ 터미널, 총 2개λ₯Ό 싀행해야함
+![image](https://github.com/user-attachments/assets/7561f579-2957-4ae3-9e4b-abcfbbc7210e)
+![image](https://github.com/user-attachments/assets/1a7f64b0-051d-47e5-8a11-5a08666fe17b)
+##### 1-1. λ°±μ—”λ“œ κ°€μƒν™˜κ²½ 생성 및 μ‹€ν–‰
+```
+cd ./agentPersona
+python -m venv [κ°€μƒν™˜κ²½μ΄λ¦„]
+./venv/Scripts/activate
+```
+##### 1.2 라이브러리 μ„€μΉ˜
+```
+pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
+pip install -r requirements.txt --no-deps
+```
+##### 1.3ν”ŒλΌμŠ€ν¬ ν”„λ‘œμ νŠΈ μ‹€ν–‰
+```
+python app4.py
+```
+##### 2.1 ν”„λŸ°νŠΈ ν”„λ‘œμ νŠΈ 라이브러리 μ„€μΉ˜
+```
+cd ./frontend # ν”„λ‘œμ νŠΈ 루트 디렉토리 κΈ°μ€€
+npm install
+```
+##### 2.2 ν”„λŸ°νŠΈ ν”„λ‘œμ νŠΈ μ‹€ν–‰
+```
+npm start
+```
+##### 3.1 μŠ€ν”„λ§ ν”„λ‘œμ νŠΈ μ‹€ν–‰
+- server λ””λ ‰ν† λ¦¬μ˜ gradle 파일 λΉŒλ“œ 및 μ‹€ν–‰
+![image](https://github.com/user-attachments/assets/43a6f66f-6261-41ce-ae8b-b2b629e7a409)
+![image](https://github.com/user-attachments/assets/e4f21c20-9ec0-49be-b108-27d3ca2b674e)
+
+##### 4. ꡬ체적인 μ‹€ν–‰ 방법 링크
+(μž‘μ„±μ˜ˆμ •)
 
 <div align="right">
 
@@ -259,12 +325,16 @@ frontend
 
 </div>
 
+
+
 ## μΆ”κ°€μžλ£Œ
+---
 ### ν”„λ‘œμ νŠΈ 관리
-- 회의둝 λ°”λ‘œκ°€κΈ°: [λ…Έμ…˜ 회의둝 λ°”λ‘œκ°€κΈ°](https://meadow-cast-ab6.notion.site/819004d3d6a94c39b9271febe71a94ee?pvs=4)</br>
+- 회의둝 λ°”λ‘œκ°€κΈ°: [λ…Έμ…˜ 회의둝 λ°”λ‘œκ°€κΈ°](https://meadow-cast-ab6.notion.site/15c2184fcc7f8017a4c1d2e5902bbcba?v=15c2184fcc7f81dc94db000c014875ba&pvs=4)</br>
 - ν”„λ‘œμ νŠΈ 일정 관리: [κ°„νŠΈμ°¨νŠΈ λ°”λ‘œκ°€κΈ°](https://docs.google.com/spreadsheets/d/1pmHWCLUkOmYGtPjWniW8xUe0MbYlfN0K/edit?gid=1439925983#gid=1439925983)
 
 
+
 ### λ°œν‘œμžλ£Œ 및 κ³„νšμ„œμ™€ λ³΄κ³ μ„œ
 - μˆ˜ν–‰κ³„νšμ„œ: [μˆ˜ν–‰κ³„νšμ„œ λ°”λ‘œλ³΄κΈ°](https://github.com/SuHyunKKim/2024-2-SCS4031-jjambbong-3/blob/main/Docs/%EC%88%98%ED%96%89%EA%B3%84%ED%9A%8D%EC%84%9C_S3_%EC%A7%AC%EB%BD%95.pdf)
 - μ΅œμ’…λ³΄κ³ μ„œ: [μ΅œμ’…λ³΄κ³ μ„œ λ°”λ‘œλ³΄κΈ°](
@@ -275,10 +345,11 @@ frontend
 
 ### ν”„λ‘œμ νŠΈ 진행 κ΄€λ ¨ 자료
 - κΈ°λŠ₯λͺ…μ„Έμ„œ: [κΈ°λŠ₯λͺ…μ„Έμ„œ λ°”λ‘œκ°€κΈ°](https://meadow-cast-ab6.notion.site/15c2184fcc7f8064af2bcdaf2561bf32?pvs=4)
+- API λͺ…μ„Έμ„œ: [API λͺ…μ„Έμ„œ λ°”λ‘œκ°€κΈ°](https://meadow-cast-ab6.notion.site/API-4f8a75307f27427297e140102ffc0222?pvs=4)
 
 
 <div align="right">
 
 [λͺ©μ°¨λ‘œ](#λͺ©μ°¨)
 
-</div>
+</div>
\ No newline at end of file