-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
109 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |