Skip to content

Commit

Permalink
๏ฟฝdocs : readme ์ถ”๊ฐ€
Browse files Browse the repository at this point in the history
  • Loading branch information
ttaehee authored May 21, 2023
1 parent 722aa08 commit 6afddf0
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
# chat-bot-gpt
# ๐ŸŒท Maeil Mail Interview (๋งค์ผ ๋ฉ”์ผ ์ธํ„ฐ๋ทฐ)
> chat gpt๋ฅผ ํ™œ์šฉํ•œ ๋ฉ”์ผ๋กœ ๋ฉด์ ‘ ์งˆ๋ฌธ์„ ๋ณด๋‚ด์ฃผ๋Š” ์„œ๋น„์Šค์ž…๋‹ˆ๋‹ค
> 2023.05.13 - ์ง„ํ–‰์ค‘
> 2023.05.13 - 2023.05.20 (ver 1.0)
<br/>

## ์„œ๋น„์Šค ์š”๊ตฌ์‚ฌํ•ญ

- ์‚ฌ์šฉ์ž๋Š” ์นดํ…Œ๊ณ ๋ฆฌ(`DB, OS, ๋„คํŠธ์›Œํฌ, ์ž๋ฃŒ๊ตฌ์กฐ`)๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ๋‹ค
- ์‚ฌ์šฉ์ž๋Š” `์ž…๋ ฅํ•œ ๋ฉ”์ผ`๋กœ `๋งค์ผ ์ผ์ • ๊ฐœ์ˆ˜`๋งŒํผ ์งˆ๋ฌธ์„ ๋ฐ›์„ ์ˆ˜ ์žˆ๋‹ค
- ์‚ฌ์šฉ์ž๋Š” ์ด๋ฉ”์ผ `์ˆ˜์‹  ์‹œ๊ฐ„`์„ ์ •ํ•  ์ˆ˜ ์žˆ๋‹ค
- ์ด๋ฉ”์ผ ์ „์†ก ์‹œ, `๋‹ต์€ ์—†์ด` ์งˆ๋ฌธ๋งŒ ์ „์†กํ•œ๋‹ค
- ์‚ฌ์šฉ์ž๋Š” ์นดํ…Œ๊ณ ๋ฆฌ(**DB, OS, ๋„คํŠธ์›Œํฌ, ์ž๋ฃŒ๊ตฌ์กฐ**)๋ฅผ ์„ ํƒํ•  ์ˆ˜ ์žˆ๋‹ค
- ์‚ฌ์šฉ์ž๋Š” **์ž…๋ ฅํ•œ ๋ฉ”์ผ**๋กœ **๋งค์ผ ์ผ์ • ๊ฐœ์ˆ˜**๋งŒํผ ์งˆ๋ฌธ์„ ๋ฐ›์„ ์ˆ˜ ์žˆ๋‹ค
- ๋งค์ผ **์ƒˆ๋ฒฝ 5์‹œ**์— ๋ชจ๋“  ์‚ฌ์šฉ์ž์—๊ฒŒ ์ผ๊ด„์ ์œผ๋กœ ์ด๋ฉ”์ผ์„ ์ „์†กํ•œ๋‹ค
- ์ด๋ฉ”์ผ ์ „์†ก ์‹œ, **๋‹ต์€ ์—†์ด** ์งˆ๋ฌธ๋งŒ ์ „์†กํ•œ๋‹ค

<br/>

## Flow
1. ์‚ฌ์šฉ์ž๋Š” ๋ณธ์ธ์˜ `๋ฉ”์ผ ์ฃผ์†Œ์™€, ์›ํ•˜๋Š” ์ˆ˜์‹  ์‹œ๊ฐ„, ์งˆ๋ฌธ ์นดํ…Œ๊ณ ๋ฆฌ`๋ฅผ ์ž…๋ ฅํ•œ๋‹ค
1. ์‚ฌ์šฉ์ž๋Š” ๋ณธ์ธ์˜ `๋ฉ”์ผ ์ฃผ์†Œ์™€ ์งˆ๋ฌธ ์นดํ…Œ๊ณ ๋ฆฌ`๋ฅผ ์ž…๋ ฅํ•œ๋‹ค
2. ๋ฉด์ ‘ ์งˆ๋ฌธ์„ `Open AI(Chat GPT)`๋ฅผ ํ†ตํ•ด ๊ฐ€์ ธ์˜จ๋‹ค
3. ์‚ฌ์šฉ์ž์—๊ฒŒ `๋ฉ”์ผ๋กœ` ์งˆ๋ฌธ์„ ๋ณด๋‚ธ๋‹ค

<br/>

## Class Diagram

<img width="653" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2023-05-21 แ„‹แ…ฉแ„’แ…ฎ 5 32 52" src="https://github.com/ttaehee/chat-bot-gpt/assets/103614357/3694ba75-191c-4860-9211-6f9df86cba4f">

<br/>

## Stack
- JAVA 17, SpringBoot 2.7.11
- SpringBoot Web, MySQL, Spring Data JPA, Lombok, Spring Cloud Starter

0 comments on commit 6afddf0

Please sign in to comment.