From 9d0ed84de439e9dae51cc0689794cf87fed3e9fa Mon Sep 17 00:00:00 2001 From: Hyeona Seol <126868156+hyeona01@users.noreply.github.com> Date: Sun, 1 Dec 2024 18:09:22 +0900 Subject: [PATCH] docs: create README.md --- README.md | 162 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 162 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3cc0482 --- /dev/null +++ b/README.md @@ -0,0 +1,162 @@ +# ๐Ÿ“‘ Project +- ํ”„๋กœ์ ํŠธ๋ช… : ์Šค๋งˆํŠธํฐ ์นด๋ฉ”๋ผ๋ฅผ ํ™œ์šฉํ•œ ์‹œํ—˜๊ฐ๋… ๋ณด์กฐ ์‹œ์Šคํ…œ - "EYESee" + +| **๊ด€๋ฆฌ์ž** | **์ˆ˜ํ—˜์ž** | +|-------------|---------------------| +| ![๋Œ€์‹œ๋ณด๋“œ๋ชฉ์—…](https://github.com/user-attachments/assets/8110567a-1d4e-4b61-b5fe-4d968f14324d) | ![๋ชจ๋ฐ”์ผ](https://github.com/user-attachments/assets/24ee359d-f08c-4bdf-b627-bf3cc1a97223) + + + + +## 1. ๊ฐœ๋ฐœ ๋™๊ธฐ ๋ฐ ๋ชฉํ‘œ + + +### 1) ๊ฐœ๋ฐœ ๋™๊ธฐ + +- **๋Œ€๊ทœ๋ชจ ์‹œํ—˜์˜ ๊ฐ๋… ์–ด๋ ค์›€** + - ๋ชจ๋“  ์ˆ˜ํ—˜์ž๋ฅผ ์‹ค์‹œ๊ฐ„์œผ๋กœ ๋ชจ๋‹ˆํ„ฐ๋งํ•˜๋Š” ๊ฒƒ์€ ํ˜„์‹ค์ ์œผ๋กœ ์–ด๋ ค์›€ + - ํŠนํžˆ ๋Œ€๋ฉด ์‹œํ—˜์—์„œ ์ˆ˜ํ—˜์ž์˜ ์‹œ์„ ๊ณผ ํ–‰๋™ ๊ฐ์‹œ๋Š” ํ•„์ˆ˜์ ์ด์ง€๋งŒ ์ธ๋ ฅ๊ณผ ๊ธฐ์ˆ ์˜ ํ•œ๊ณ„๋กœ ์ธํ•ด ๋ถ€์ •ํ–‰์œ„ ๊ฐ์ง€์— ์–ด๋ ค์›€ ์กด์žฌ +- **๋ถ€์ •ํ–‰์œ„์˜ ์ž ์žฌ์  ์œ„ํ—˜** + - ์ˆ˜ํ—˜์ž๊ฐ€ ์‹œํ—˜์ง€ ์ด์™ธ์˜ ์žฅ์†Œ๋ฅผ ์ฃผ์‹œํ•˜๊ฑฐ๋‚˜ ๋ถ€์ •ํ•œ ๋ฌผ์ฒด๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ๋ฐœ์ƒ + - ์ด๋Ÿฌํ•œ ํ–‰๋™์„ ์‹ค์‹œ๊ฐ„์œผ๋กœ ๊ฐ์‹œํ•˜๊ณ  ์ œ์–ดํ•  ํ•„์š”์„ฑ ๋Œ€๋‘ +- **๊ณต์ •ํ•œ ์‹œํ—˜ ํ™˜๊ฒฝ ๊ตฌ์ถ• ํ•„์š”** + - ๋ถ€์ •ํ–‰์œ„๋ฅผ ์‹ค์‹œ๊ฐ„์œผ๋กœ ๊ฐ์ง€ํ•˜์—ฌ ๋ชจ๋“  ์ˆ˜ํ—˜์ž์—๊ฒŒ ๋™๋“ฑํ•œ ์‹œํ—˜ ํ™˜๊ฒฝ ์ œ๊ณต ํ•„์š” + +### 2) ๊ฐœ๋ฐœ ๋ชฉํ‘œ + +- **์‹ค์‹œ๊ฐ„ ๋ถ€์ •ํ–‰์œ„ ๊ฐ์ง€ ์‹œ์Šคํ…œ ๊ฐœ๋ฐœ** + - ๋ชจ๋ฐ”์ผ ์นด๋ฉ”๋ผ์™€ AI ๊ธฐ๋ฐ˜์˜ ์‹œ์„  ์ถ”์  ๋ฐ ๊ฐ์ฒด ํƒ์ง€ ๊ธฐ์ˆ ์„ ๊ฒฐํ•ฉ + - ์ˆ˜ํ—˜์ž์˜ ์‹œ์„  ๋ฐ ํ–‰๋™์„ ๋ชจ๋‹ˆํ„ฐ๋งํ•˜์—ฌ ๋ถ€์ •ํ–‰์œ„ ๋ฐœ์ƒ ์‹œ ๊ฒฝ๊ณ  ๋ฉ”์‹œ์ง€ ๋ฐœ์†ก +- **์‹œํ—˜ ๊ด€๋ฆฌ ํšจ์œจ์„ฑ ์ฆ๋Œ€** + - ๊ฐ๋…๊ด€์˜ ๋ถ€๋‹ด์„ ์ค„์ด๊ณ  ๋‹ค์ˆ˜์˜ ์ˆ˜ํ—˜์ž๋ฅผ ํšจ๊ณผ์ ์œผ๋กœ ๊ด€๋ฆฌ +- **๊ณต์ •ํ•œ ํ‰๊ฐ€ ๊ตฌํ˜„** + - ๋ถ€์ •ํ–‰์œ„๋ฅผ ์ตœ์†Œํ™”ํ•˜์—ฌ ์ˆ˜ํ—˜์ž๋“ค์—๊ฒŒ ๊ณต์ •ํ•œ ์‹œํ—˜ ๊ธฐํšŒ ์ œ๊ณต + +## 2. ํ•„์š”์„ฑ + +- **๋Œ€๋ฉด ์‹œํ—˜ ๋ถ€์ •ํ–‰์œ„ ๋ฐฉ์ง€ ์‹œ์Šคํ…œ์˜ ๋ถ€์žฌ** + - ๊ธฐ์กด ์‹œ์Šคํ…œ์€ ๋น„๋Œ€๋ฉด ์‹œํ—˜์— ์ดˆ์ ์„ ๋งž์ถ”์–ด ๋Œ€๋ฉด ์‹œํ—˜์—์„œ๋Š” ํ™œ์šฉ์ด ์ œํ•œ์  +- **๊ธฐ์กด ๋ถ€์ •ํ–‰์œ„ ๊ฐ์ง€ ๋ฐฉ์‹์˜ ํ•œ๊ณ„** + - ๊ฐ๋…๊ด€์˜ ์ง๊ด€์— ์˜์กดํ•˜์—ฌ ๊ฐ์ง€์œจ์ด ๋‚ฎ๊ณ  ์ผ๊ด€์„ฑ์ด ๋ถ€์กฑ +- **์‹œ์„  ์ถ”์  ๋ฐ ๊ฐ์ฒด ํƒ์ง€ ๊ธฐ์ˆ ์˜ ๋ฐœ์ „** + - AI ๊ธฐ์ˆ ์˜ ๋ฐœ์ „์œผ๋กœ ์‹ค์‹œ๊ฐ„ ๊ฐ์ง€ ๋ฐ ๋ถ„์„ ๊ฐ€๋Šฅ + - ๊ต์œก ๋ฐ ์‹œํ—˜ ๊ฐ๋… ๋ถ„์•ผ์—์„œ์˜ ์ ์šฉ์œผ๋กœ ๋ถ€์ •ํ–‰์œ„ ๋ฐฉ์ง€์— ๊ธฐ์—ฌ +- **ํšจ์œจ์ ์ธ ์‹œํ—˜ ๊ด€๋ฆฌ ํ•„์š”** + - ๋Œ€๊ทœ๋ชจ ์‹œํ—˜์—์„œ ๊ฐ๋… ํšจ์œจ์„ฑ์„ ๋†’์ด๊ณ  ๋ถ€์ •ํ–‰์œ„๋ฅผ ์˜ˆ๋ฐฉํ•˜์—ฌ ๊ณต์ •์„ฑ ํ™•๋ณด + + +## 3. ์ฐจ๋ณ„์  ๋ฐ ๊ฐœ์„ ์  + +- **๋Œ€๋ฉด ์‹œํ—˜ ํ™˜๊ฒฝ์— ํŠนํ™”** + - ๊ธฐ์กด ์‹œ์Šคํ…œ์€ ๋น„๋Œ€๋ฉด ์‹œํ—˜ ํ™˜๊ฒฝ์— ์ตœ์ ํ™”๋œ ๋ฐ˜๋ฉด, ๋ณธ ์‹œ์Šคํ…œ์€ ๋Œ€๋ฉด ์‹œํ—˜ ํ™˜๊ฒฝ์— ๋งž์ถฐ ์„ค๊ณ„๋จ + - ๋ชจ๋ฐ”์ผ ์นด๋ฉ”๋ผ๋ฅผ ํ™œ์šฉํ•ด ์ˆ˜ํ—˜์ž์˜ ์‹œ์„ ์„ ์ถ”์ ํ•˜๊ณ , ์†์ด๋‚˜ ์ฑ…์ƒ ์œ„ ๋ฌผ์ฒด๋ฅผ ๊ฐ์ง€ํ•˜๋Š” ๊ฐ์ฒด ํƒ์ง€ ๊ธฐ๋Šฅ ์ œ๊ณต + +- **๋‹ค์–‘ํ•œ ๋ถ€์ •ํ–‰์œ„ ์œ ํ˜• ๊ฐ์ง€** + - ์‹œ์„  ์ถ”์ ์„ ํ†ตํ•ด ์‹œํ—˜์ง€ ์ด์™ธ์˜ ์žฅ์†Œ๋ฅผ ์ฃผ์‹œํ•˜๋Š” ํ–‰์œ„ ๊ฐ์ง€ + - ๊ฐ์ฒด ํƒ์ง€๋กœ ์†์ด๋‚˜ ์ฑ…์ƒ ์œ„ ๋ถ€์ • ๋ฌผ์ฒด ์‚ฌ์šฉ ์—ฌ๋ถ€ ์‹ค์‹œ๊ฐ„ ๊ฐ์ง€ + +- **ํšจ์œจ์ ์ธ ๋ฐ์ดํ„ฐ ๊ด€๋ฆฌ** + - ๊ฒฝ๊ณ ๊ฐ€ ๋ฐœ์ƒํ•  ๋•Œ์—๋งŒ ์˜์ƒ์„ ๋…นํ™”ํ•˜์—ฌ ๋ฐ์ดํ„ฐ ์ฒ˜๋ฆฌ ๋ถ€๋‹ด ๊ฐ์†Œ + - ๋ถˆํ•„์š”ํ•œ ์˜์ƒ ์ €์žฅ์„ ๋ฐฉ์ง€ํ•˜๊ณ  ์ €์žฅ์†Œ ํšจ์œจ์„ฑ ๊ทน๋Œ€ํ™” + +- **์‹ค์‹œ๊ฐ„ ์•Œ๋ฆผ ์‹œ์Šคํ…œ** + - ๋ถ€์ •ํ–‰์œ„ ๊ฐ์ง€ ์‹œ ๊ฐ๋…๊ด€์—๊ฒŒ ์ฆ‰๊ฐ ์•Œ๋ฆผ ์ „์†ก + - ๊ฐ๋…๊ด€์˜ ํšจ์œจ์ ์ธ ๊ฐœ์ž… ์ง€์›์œผ๋กœ ์‹œํ—˜ ๊ด€๋ฆฌ ๋ถ€๋‹ด ๊ฒฝ๊ฐ + + + + + + +
+
+ +# ๐ŸŽจ ํ”„๋กœ์ ํŠธ ์„ค๊ณ„ + +## 1. ํ”Œ๋กœ์šฐ์ฐจํŠธ + +![แ„‘แ…ณแ†ฏแ„…แ…ฉแ„‹แ…ฎแ„Žแ…กแ„แ…ณ](https://github.com/user-attachments/assets/f67e9411-2002-477b-989f-54edeb8c4790) + + + +## 2. ERD +ERD + + + +## 3. ๊ฐœ๋ฐœ ํ™˜๊ฒฝ + +| **๋ถ„๋ฅ˜** | **๊ธฐ์ˆ  ์Šคํƒ** | +|-------------|---------------------| +| **AI** | YOLO v8, MediaPipe | +| **Frontend**| NEXT.js, Vercel | +| **Backend** | Spring Boot, MySQL, Redis, AWS RDS, AWS EC2, nginx | + +
+ +## 4. ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜ +แ„‹แ…กแ„แ…ตแ„แ…ฆแ†จแ„Žแ…ง + + +

+ +# โš™๏ธ ํŒŒํŠธ๋ณ„ ํ•ต์‹ฌ ๊ธฐ์ˆ  + +## 1. AI + + +## 2. ํ”„๋ก ํŠธ์—”๋“œ + + +## 3. ๋ฐฑ์—”๋“œ + + +

+ +# ๐ŸŽฌ ์‹œ์—ฐ ์˜์ƒ +(๋งํฌ) + +

+ +# ๐Ÿ›œ ์ ‘์† ๋งํฌ +- ์ˆ˜ํ—˜์ž + https://eyesee-exam.vercel.app + +- ๊ด€๋ฆฌ์ž + https://eyesee-admin.vercel.app + +
+ +# ๐Ÿฆ‰ Team +| **์ด๋ฆ„** | **ํ•™๊ณผ** | **ํ•™๋ฒˆ** | **์—ญํ• ** | **์ฃผ์š” ์—…๋ฌด** | +|----------------------|------------------|--------------|-----------------------------------|------------------------------------------------| +| [์ฒœ๊ธฐ์ •](https://github.com/gi-jeong1000) | ์‚ฐ์—…์‹œ์Šคํ…œ๊ณตํ•™๊ณผ | 2019112471 | AI | ๊ฐ์ฒด ํƒ์ง€ ๋ฐ ์‹œ์„  ์ถ”์  AI ๊ฐœ๋ฐœ | +| [์„คํ˜„์•„](https://github.com/hyeona01) | ์œตํ•ฉ๋ณด์•ˆํ•™๊ณผ | 2022113107 | Frontend | UI/UX ์„ค๊ณ„ ๋ฐ ํ”„๋ก ํŠธ์—”๋“œ ๊ฐœ๋ฐœ | +| [์ด์ข…๋ฒ”](https://github.com/JongbeomLee623) | ๊ฒฝ์˜์ •๋ณดํ•™๊ณผ | 2019111598 | Backend | AWS EC2 & nginx ์„œ๋ฒ„ ๊ฐœ๋ฐœ, ๋ฐฑ์—”๋“œ API ๊ฐœ๋ฐœ | +| [๊น€ํ˜ธ์ •](https://github.com/HOJEONGKIMM) | ๊ฒฝ์˜์ •๋ณดํ•™๊ณผ | 2020111556 | Backend | ๋ฐฑ์—”๋“œ API ๊ฐœ๋ฐœ | + + +## ๐Ÿง‘๐Ÿปโ€๐Ÿซ Mentor + +- [๊น€์ฃผ์˜ ๋ฉ˜ํ† ๋‹˜] + + +
+ +# ๐Ÿ”’ ํ˜‘์—… ๊ทœ์น™ +## ๋ธŒ๋žœ์น˜ ๊ทœ์น™ + +- **๋ฉ”์ธ ๋ธŒ๋žœ์น˜์—์„œ ๋ถ„๊ธฐํ•˜์—ฌ ์‚ฌ์šฉ** + - ๋ธŒ๋žœ์น˜ ์ด๋ฆ„ ๊ทœ์น™: + ```html + frontend/feature/signin + backend/fix + ai/feature + ``` + +## ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ๊ทœ์น™ + +- ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์ž‘์„ฑ ํ˜•์‹: + ```html + BE: [feature] dto ๊ตฌ์กฐ ๋ณ€๊ฒฝ #1 + ```