Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kduoh99 authored Aug 5, 2024
1 parent c2918e7 commit 12677f7
Showing 1 changed file with 109 additions and 22 deletions.
131 changes: 109 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,112 @@
# LikeLion-12th-TEAM02-BE
๐Ÿฆ ๋ฉ‹์Ÿ์ด์‚ฌ์ž์ฒ˜๋Ÿผ 12๊ธฐ SKHU ํ•ด์ปคํ†ค 2ํŒ€ ๋ฐฑ์—”๋“œ ๋ ˆํฌ์ง€ํ† ๋ฆฌ์ž…๋‹ˆ๋‹ค.

# MoodFriend
MoodFriend ์บ๋ฆญํ„ฐ์ธ ํ˜ธ์•ผ๊ฐ€ ์‚ฌ์šฉ์ž์˜ ์นœ๊ตฌ๊ฐ€ ๋˜์–ด ๊ฐ์ •์„ ๊ด€๋ฆฌํ•ด์ฃผ๋Š” ์„œ๋น„์Šค.

# ์ฃผ์š” ๊ธฐ๋Šฅ
1. ์˜ค๋ธŒ์ œ ๊พธ๋ฏธ๊ธฐ ๊ธฐ๋Šฅ
- ์ƒ์ ์— ์žˆ๋Š” ์˜ค๋ธŒ์ œ๋ฅผ ๊ตฌ๋งคํ•˜์—ฌ ์ž์‹ ์˜ ์บ๋ฆญํ„ฐ์ธ ํ˜ธ์•ผ๋ฅผ ๊พธ๋ฐ€ ์ˆ˜ ์žˆ๋Š” ๊ธฐ๋Šฅ
2. ํ˜ธ์•ผ์™€์˜ ๋Œ€ํ™” ๊ธฐ๋Šฅ
- ํ”„๋กฌํ”„ํŠธ ์—”์ง€๋‹ˆ์–ด๋ง์„ ์‚ฌ์šฉํ•˜์—ฌ ํ˜ธ์•ผ์™€ 1:1 ๋Œ€ํ™” ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋Š” ๊ธฐ๋Šฅ
3. ์‚ฌ์šฉ์ž์˜ ๊ฐ์ • ํŠธ๋ž˜์ปค๋ฅผ ๋“ฑ๋กํ•˜๋Š” ๊ธฐ๋Šฅ
- ํ•˜๋ฃจ์— ํ•œ๋ฒˆ์”ฉ ์‚ฌ์šฉ์ž์˜ ๋ฌด๋“œ ํŠธ๋ž˜์ปค๋ฅผ ๋“ฑ๋กํ•  ์ˆ˜ ์žˆ๋Š” ๊ธฐ๋Šฅ
4. ์ผ๊ธฐ ์ž‘์„ฑ ๊ธฐ๋Šฅ
- ์‚ฌ์šฉ์ž๋Š” ์ผ๊ธฐ๋ฅผ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ๊ณ , AI๊ฐ€ ํ•˜๋ฃจ ์ผ๊ธฐ๋ฅผ ์š”์•ฝํ•ด ์ฃผ๋Š” ๊ธฐ๋Šฅ
5. ์ฃผ๋ณ€ ์ „๋ฌธ ์˜๋ฃŒ ๊ธฐ๊ด€ ์ถ”์ฒœ ๊ธฐ๋Šฅ
- ์ง€๋„ API๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์‚ฌ์šฉ์ž์˜ ์ฃผ๋ณ€์— ์žˆ๋Š” ์˜๋ฃŒ ์ „๋ฌธ ๊ธฐ๊ด€์„ ์ถ”์ฒœํ•ด ์ฃผ๋Š” ๊ธฐ๋Šฅ

# Database ERD
![MoodFriendERD](https://github.com/user-attachments/assets/69a1d988-2bc9-4c83-808c-e413dfabf6a7)

# Repository
BackEnd : https://github.com/LikeLion-12th-SKHU/LikeLion-12th-TEAM02-BE.git

FrontEnd : https://github.com/LikeLion-12th-SKHU/LikeLion-12th-TEAM02-FE.git
<br/>

## ๐Ÿฏ ์ด๊ณต์—†๋Š” ์ด๊ณต๊ณ„

- MoodFriend ๋Œ€ํ‘œ ์บ๋ฆญํ„ฐ์ธ ํ˜ธ์•ผ๊ฐ€ ์‚ฌ์šฉ์ž์˜ ์นœ๊ตฌ๊ฐ€ ๋˜์–ด ๊ฐ์ • ๊ด€๋ฆฌ๋ฅผ ๋„์™€์ฃผ๋Š” ์„œ๋น„์Šค
- `2024. 07. 14~ 08. 05`

<br/>

### โœจ ์ฃผ์š” ๊ธฐ๋Šฅ

1. ํ˜ธ์•ผ์™€์˜ ๋Œ€ํ™”

- ์ž์ฒด, ์นด์นด์˜ค, ๊ตฌ๊ธ€ ๋กœ๊ทธ์ธ์„ ํ†ตํ•œ ํ˜ธ์•ผ์™€์˜ 1:1 ๋Œ€ํ™” ๊ธฐ๋Šฅ
- ํ”„๋กฌํ”„ํŠธ ์—”์ง€๋‹ˆ์–ด๋ง์„ ํ†ตํ•œ ์‘๋‹ต ํ’ˆ์งˆ ๊ฐœ์„ 
- DeepL API๋ฅผ ํ†ตํ•œ ํ† ํฐ ์ ˆ์•ฝ

2. ๊ฐ์ • ํŠธ๋ž˜์ปค

- cron ํ‘œํ˜„์‹์„ ํ†ตํ•ด ์ง€์ •๋œ ์‹œ๊ฐ„์— ํ˜ธ์•ผ์™€์˜ ์ผ์ผ ๋Œ€ํ™” ๋‚ด์šฉ์ด ์š”์•ฝ๋˜์–ด AI ์ผ๊ธฐ์— ์ €์žฅ
- AI ์ผ๊ธฐ ์กฐํšŒ ๋ฐ ์‚ญ์ œ ๊ธฐ๋Šฅ
- ์‚ฌ์šฉ์ž ์ผ๊ธฐ CRUD ๊ธฐ๋Šฅ
- ์บ˜๋ฆฐํ„ฐ ํ˜•์‹์œผ๋กœ ์›”๋ณ„ ๊ฐ์ • ์กฐํšŒ
- ์ง€๋„ API๋ฅผ ํ†ตํ•œ ์‚ฌ์šฉ์ž ์ฃผ๋ณ€ ์ „๋ฌธ ์˜๋ฃŒ๊ธฐ๊ด€ ์ถ”์ฒœ

3. ์นœ๊ตฌ

- ๋‹ค๋ฅธ ์‚ฌ์šฉ์ž์—๊ฒŒ ์นœ๊ตฌ ์š”์ฒญ ์ „์†ก, ์š”์ฒญ์„ ๋ฐ›์€ ์‚ฌ์šฉ์ž๊ฐ€ ์ˆ˜๋ฝํ•˜๋ฉด ์„œ๋กœ ์นœ๊ตฌ๋กœ ๋“ฑ๋ก
- ์นœ๊ตฌ๋กœ ๋“ฑ๋ก๋œ ์‚ฌ์šฉ์ž์˜ ์ตœ๊ทผ ๊ฐ์ • ์ƒํƒœ ์กฐํšŒ ๊ฐ€๋Šฅ
- ํ•œ์ชฝ์—์„œ ์นœ๊ตฌ๋ฅผ ์‚ญ์ œํ•˜๋ฉด ์–‘๋ฐฉํ–ฅ์œผ๋กœ ์‚ญ์ œ

4. ์˜ค๋ธŒ์ œ ๊พธ๋ฏธ๊ธฐ

- ๊ฒฐ์ œ(PortOne) API๋ฅผ ํ†ตํ•œ ๋งˆ์ผ๋ฆฌ์ง€ ์ถฉ์ „
- ๋ณด์œ  ๋งˆ์ผ๋ฆฌ์ง€๋กœ ์ƒ์ ์—์„œ ์˜ค๋ธŒ์ œ ๊ตฌ๋งค ๊ฐ€๋Šฅ
- ๋ณด์œ  ์˜ค๋ธŒ์ œ ์ƒํƒœ ๊ด€๋ฆฌ(true/false)๋กœ ๊พธ๋ฏธ๊ธฐ ๊ฐ€๋Šฅ

<br/>

### ๐Ÿ‘ฅ Member

| FrontEnd | BackEnd |
| :------: | :-----: |
| [๊น€์€ํ˜œ](https://github.com/GraceKim527), [์˜ค์ˆ˜๊ฒฝ](https://github.com/SuKyeong2002) | [๊ฐ•๋‘์˜ค](https://github.com/kduoh99), [์ง€์ •์šฑ](https://github.com/dkdpawjddnr) |

<br/>

### ๐Ÿ”— Repository & Deploy Links

- [FrontEnd Repo](https://github.com/LikeLion-12th-SKHU/LikeLion-12th-TEAM02-FE) | [FrontEnd Deploy](https://moodfriend.vercel.app)
- [BackEnd Repo](https://github.com/LikeLion-12th-SKHU/LikeLion-12th-TEAM02-BE) | [BackEnd Deploy](https://moodfriend.site)

<br/>

### ๐Ÿ“ƒ API Documentation

- [Swagger](https://moodfriend.site/swagger-ui/index.html)

<br/>

### ๐Ÿ—ƒ๏ธ ERD

![แ„’แ…ฉแ„‹แ…ฃ](https://github.com/user-attachments/assets/5fd90ffc-69c6-4132-b810-4353bbd359be)

<br/>

### ๐ŸŒฑ Git Flow

1. ์ž‘์—… ํด๋” ์ƒ์„ฑ ๋ฐ ์ดˆ๊ธฐํ™”

```bash
git init
git remote add upstream [๋ ˆํฌ ์ฃผ์†Œ]
git remote add origin [๋ ˆํฌ ์ฃผ์†Œ]
```

2. local main์—์„œ upstream pull ํ›„, origin push

```bash
git switch main
git pull upstream main
git push origin main
```

3. ์ด์Šˆ ์ƒ์„ฑ ๋ฐ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ

```bash
git switch -c [๋ธŒ๋žœ์น˜๋ช…]
```

4. ์ž‘์—… ๋ฐ ์ปค๋ฐ‹

```bash
git add .
git commit -m "์ž‘์—… ๋‚ด์šฉ"
```

5. ์ถฉ๋Œ ํ•ด๊ฒฐ ํ›„, PR ์˜ฌ๋ฆฌ๊ธฐ

```bash
git pull upstream main
git push origin [๋ธŒ๋žœ์น˜๋ช…]
```

6. merge ํ›„, ์ž‘์—…๊ณต๊ฐ„์œผ๋กœ ๋Œ์•„์˜ค๊ธฐ

```bash
git checkout main
```

0 comments on commit 12677f7

Please sign in to comment.