kookmin-sw / capstone-2024-30

์™ธ๊ตญ์ธ ์œ ํ•™์ƒ์„ ์œ„ํ•œ ์•ฑ์„œ๋น„์Šค
https://kookmin-sw.github.io/capstone-2024-30
16 stars 3 forks source link
ai docker firebase-auth flutter github-actions spring-boot spring-security

Review Assignment Due Date Open in Visual Studio Code

๐Ÿ’ป ์บก์Šคํ†ค 30์กฐ ๊ฒฐ๊ณผ๋ฌผ ์†Œ๊ฐœ


Typing SVG

แ„Žแ…ฌแ„Œแ…ฉแ†ผ แ„‡แ…กแ†ฏแ„‘แ…ญแ„Œแ…กแ„…แ…ญ

[์ค‘๊ฐ„๋ฐœํ‘œ ์ž๋ฃŒ ๋ฐ ๋ณด๊ณ ์„œ]

[์ตœ์ข…๋ฐœํ‘œ ์ž๋ฃŒ&ํฌ์Šคํ„ฐ ๋ฐ ๋ณด๊ณ ์„œ]

[Github ํ™ˆํŽ˜์ด์ง€]

ํŒŒํŠธ๋ณ„ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ๊ฐ ํ”„๋กœ์ ํŠธ ๋””๋ ‰ํ† ๋ฆฌ ๋งˆํฌ๋‹ค์šด ๋ฌธ์„œ์— ์žˆ์Šต๋‹ˆ๋‹ค.

ํ”„๋ก ํŠธ ๋ฐฑ AI
FRONT.md BACK.md AI.md



Play ์Šคํ† ์–ด ๋‹ค์šด๋กœ๋“œ

1. ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ

์ด ํ”„๋กœ์ ํŠธ๋Š” ๊ตญ๋ฏผ๋Œ€ํ•™๊ต ์œ ํ•™์ƒ๋“ค์ด ๊ฒช๋Š” ์–ธ์–ด์ , ๋ฌธํ™”์  ๋ถˆํŽธํ•จ์„ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•œ ํ”„๋กœ์ ํŠธ์ž…๋‹ˆ๋‹ค. ์ด ํ”„๋กœ์ ํŠธ์—์„œ ์ œ๊ณตํ•˜๋Š” ์•ฑ์—์„œ ์œ ํ•™์ƒ๋“ค์ด ์บ ํผ์Šค ์ƒํ™œ์— ๋น ๋ฅด๊ฒŒ ์ ์‘ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋‹ค์–‘ํ•œ ์ •๋ณด์™€ ์„œ๋น„์Šค๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.


2. Abstract

This project aims to develop a comprehensive app service for international students studying at Kookmin University. The app provides a variety of information and services to help students quickly adapt to campus life.


3. ์†Œ๊ฐœ ์˜์ƒ

https://github.com/kookmin-sw/capstone-2024-30/assets/55117706/69c09b39-f44e-4edf-abab-6b16485a2f57


4. ํ”„๋กœ์ ํŠธ ๊ธฐ๋Šฅ

1๏ธโƒฃ ๋ฒˆ์—ญ๋œ ๊ณต์ง€์‚ฌํ•ญ / ํ•™์‹ / ํ•™๊ต์ •๋ณด ์ œ๊ณต

๊ตญ๋ฏผ๋Œ€ํ•™๊ต์—์„œ๋Š” ๊ณต์ง€์‚ฌํ•ญ, ํ•™์‹, ํ•™๊ต์ •๋ณด์˜ ๋ฒˆ์—ญ์„ ์ž˜ ์ง€์›ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ์ด์—๋”ฐ๋ผ ์™ธ๊ตญ์ธ ์œ ํ•™์ƒ๋“ค์€ ๋งค๋ฒˆ ๋ฒˆ์—ญ๊ธฐ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ํ•™๊ต์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ์–ป๊ธฐ ๋•Œ๋ฌธ์— ์ •๋ณด์˜ ์ ‘๊ทผ์„ฑ์ด ๋‚ฎ์Šต๋‹ˆ๋‹ค.

๋”ฐ๋ผ์„œ, ์™ธ๊ตญ๋ฏผ ์„œ๋น„์Šค๋Š” ์„ค์ •ํ•œ ์–ธ์–ด์— ๋งž์ถฐ์„œ ๊ณต์ง€์‚ฌํ•ญ/ํ•™์‹/ํ•™๊ต์ •๋ณด ๋ฒˆ์—ญ๋ณธ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

๋ฒˆ์—ญ๋œ ๊ณต์ง€์‚ฌํ•ญ ๊ณต์ง€์‚ฌํ•ญ ๋””ํ…Œ์ผ ๋ฒˆ์—ญ๋œ ํ•™์‹์ •๋ณด


2๏ธโƒฃ ์ฑ—๋ด‡ ๊ธฐ๋Šฅ

๊ตญ๋ฏผ๋Œ€ํ•™๊ต์—์„œ๋Š” ON๊ตญ๋ฏผ ์ฑ—๋ด‡ "์ฟ ๋ฏผ์ด"๋ฅผ ์„œ๋น„์Šคํ•˜๊ณ ์žˆ์œผ๋‚˜, ์„ฑ๋Šฅ์ด ๋งค์šฐ ํ˜•ํŽธ์—†์Šต๋‹ˆ๋‹ค. ๊ฐ„๋‹จํ•œ ์งˆ๋ฌธ์—๋„ ๋™๋ฌธ์„œ๋‹ต์„ ํ•˜๊ฑฐ๋‚˜, ์˜์–ด๋กœ ์งˆ๋ฌธํ–ˆ๋Š”๋ฐ ํ•œ๊ธ€๋กœ ๋‹ต๋ณ€ํ•˜๋Š” ๋“ฑ ์ „ํ˜€ ์ฑ—๋ด‡์œผ๋กœ์„œ์˜ ๊ธฐ๋Šฅ์„ ์ˆ˜ํ–‰ํ•˜์ง€ ๋ชปํ•˜๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.

๋”ฐ๋ผ์„œ, ์™ธ๊ตญ๋ฏผ์€ RAG์™€ LLM์„ ์‚ฌ์šฉํ•˜์—ฌ ๊ตญ๋ฏผ๋Œ€ํ•™๊ต์— ํŠนํ™”๋œ ๋‹ต๋ณ€์„ ์ œ๊ณตํ•˜๊ณ  ๋‹ค๊ตญ์–ด๋ฅผ ์ง€์›ํ•˜๋Š” "KuKu" ์ฑ—๋ด‡์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

๊ตญ๋ฏผ๋Œ€ ๊ด€๋ จ ์งˆ๋ฌธ ๋‹ค๊ตญ์–ด ์ง€์› ์ผ์ƒ ๋Œ€ํ™”


3๏ธโƒฃ ๋ฐœ์Œ ๊ต์ • ๊ธฐ๋Šฅ

๋งŽ์€ ์™ธ๊ตญ์ธ๋“ค์€ ํ•œ๊ตญ์— ์™€์„œ ์–ธ์–ด ๋ฌธ์ œ๋กœ ํž˜๋“ค์–ดํ•ฉ๋‹ˆ๋‹ค. ํŠนํžˆ ํ•™๊ต ์ƒํ™œ์„ ํ•˜๋‹ค๋ณด๋ฉด ๋ฐœํ‘œ๋ฅผ ํ•˜๊ฑฐ๋‚˜ ์ผ์ƒ์ƒํ™œ์—์„œ ์˜์‚ฌ์†Œํ†ต์„ ํ•ด์•ผํ•  ๋•Œ, ๋ณธ์ธ์˜ ๋ฐœ์Œ์ด ์ •ํ™•ํ•œ์ง€ ํ™•์ธํ•  ๋ฐฉ๋ฒ•์ด ์—†์–ด์„œ ํž˜๋“ค์–ดํ•ฉ๋‹ˆ๋‹ค.

๋”ฐ๋ผ์„œ, ์™ธ๊ตญ๋ฏผ์€ ์ž์‹ ์˜ ๋ฐœํ‘œ ์Šคํฌ๋ฆฝํŠธ๋ฅผ ์ž…๋ ฅ์œผ๋กœ ๋„ฃ์–ด์„œ ๋ฐœ์Œ ํ‰๊ฐ€๋ฅผ ๋ฐ›์„ ์ˆ˜ ์žˆ์„ ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ, ํ•œ๊ตญ์˜ ์ผ์ƒ์ƒํ™œ์—์„œ ๋งŽ์ด ์“ฐ์ด๋Š” ์—ฌ๋Ÿฌ ํ‘œํ˜„๋“ค์„ ์—ฐ์Šตํ•  ์ˆ˜ ์žˆ๋„๋กํ•˜์—ฌ ํ•œ๊ตญ ์œ ํ•™์ƒํ™œ์„ ๋•๊ณ ์ž ํ•ฉ๋‹ˆ๋‹ค.

์ผ์ƒ์ƒํ™œ์— ์ž์ฃผ์“ฐ๋Š” ์˜ˆ๋ฌธ ์ง€์› ๋ฌธ์žฅ ์ปค์Šคํ…€ ์ง€์› ๋ฐœ์Œ ํ‰๊ฐ€ ์ œ๊ณต


4๏ธโƒฃ ํ—ฌํผ ๋งค์นญ ๊ธฐ๋Šฅ

๋งŽ์€ ์™ธ๊ตญ์ธ๋“ค์ด ๋‚ฏ์„  ๋•…์— ์™”์„ ๋•Œ ๋„์›€์„ ๋ฐ›์„ ์‚ฌ๋žŒ์ด ์—†์–ด์„œ ๋งค์šฐ ํž˜๋“ค์–ดํ•ฉ๋‹ˆ๋‹ค.

๋”ฐ๋ผ์„œ, ์™ธ๊ตญ๋ฏผ์€ ์™ธ๊ตญ์ธ๋“ค์„ ๋„์šธ ์ˆ˜ ์žˆ๋„๋ก ํ—ฌํผ ๋งค์นญ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ํ•œ๊ตญ์ธ or ์˜ค๋žœ ์œ ํ•™์ƒํ™œ์„ ํ•˜์—ฌ ํ•œ๊ตญ ์ƒํ™œ์— ์ต์ˆ™ํ•ด์ง„ ์™ธ๊ตญ์ธ ํ—ฌํผ๋ฅผ ๊ตฌํ•  ์ˆ˜ ์žˆ๋„๋ก ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

ํ—ฌํผ ๋ฐ ํ—ฌํ”ผ ๊ฒŒ์‹œํŒ ๋””ํ…Œ์ผ ์ฑ„ํŒ…


5๏ธโƒฃ Q&A์™€ FAQ ๊ธฐ๋Šฅ

์œ ํ•™์ƒ๋“ค์ด ํ•œ๊ตญ์ƒํ™œ์—์„œ ๊ถ๊ธˆํ•œ ๊ฒƒ์„ ๋ฌผ์–ด๋ณผ๋งŒํ•œ ๊ณณ์ด ๋งˆ๋•…์น˜ ์•Š๊ณ , ON๊ตญ๋ฏผ์— ์žˆ๋Š” FAQ์˜ ์กด์žฌ๋ฅผ ์•Œ๊ธฐ ์‰ฝ์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ํ•˜์ง€๋งŒ, ์ด FAQ ๋˜ํ•œ ๋ฒˆ์—ญ์„ ์ œ๊ณตํ•˜์ง€ ์•Š๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค.

๋”ฐ๋ผ์„œ, ์™ธ๊ตญ๋ฏผ์€ Q&A ๊ฒŒ์‹œํŒ๊ณผ ๋‹ค๊ตญ์–ด๋กœ ๋ฒˆ์—ญ๋œ FAQ๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

Q&A ๊ฒŒ์‹œํŒ ๋””ํ…Œ์ผ FAQ ์กฐํšŒ


5. ํŒ€์› ์†Œ๊ฐœ

์ตœ์ง€ํ›ˆ ๊น€๋ฏผ์ œ ์กฐํ˜„์ง„
****1683 ****1557 ****1675
๐Ÿ‘‘ Frontend Frontend Backend
์ฑ„์›์ฐฌ ๊น€ํ˜œ์„ฑ ์ตœ์˜๋ฝ
****1676 ****1582 ****1678
Backend AI AI


6. ๊ธฐ์ˆ ์Šคํƒ

๐Ÿ›  Frontend

์—ญํ•  ์ข…๋ฅ˜
Framework
Database RED RED
Programming Language
Device


๐Ÿ’พ Backend

์—ญํ•  ์ข…๋ฅ˜
Framework RED RED RED RED
Database RED RED
Programming Language RED RED
Test RED RED
Deploy RED RED RED RED RED RED RED
CI/CD RED
ETC RED RED RED


๐Ÿ“ป AI

์—ญํ•  ์ข…๋ฅ˜
Programming Language RED
Development RED RED
Technology RED RED
Test
Server


๐Ÿ”จ Tools

์—ญํ•  ์ข…๋ฅ˜
Version Control
Cooperation RED RED RED
Test



7. ์‹œ์Šคํ…œ ๊ตฌ์กฐ

๐Ÿ’ป ์„œ๋น„์Šค ์•„ํ‚คํƒ์ฒ˜


๐Ÿค– ์ฑ—๋ด‡ ์•„ํ‚คํ…์ฒ˜


๐Ÿ“‚ ๋””๋ ‰ํ† ๋ฆฌ ๊ตฌ์กฐ

โ”œโ”€โ”€ ๐Ÿ“‚.github

โ”œโ”€โ”€ ๐Ÿ“‚front ๐Ÿ—‚ ํ”„๋ก ํŠธ ์•ฑ ์†Œ์Šค (Flutter)

โ”œโ”€โ”€ ๐Ÿ“‚back-gateway ๐Ÿ—‚ ๋ฐฑ์—”๋“œ Api Gateway (Spring Cloud Gateway)

โ”œโ”€โ”€ ๐Ÿ“‚back ๐Ÿ—‚ ๋ฐฑ์—”๋“œ ๋ฉ”์ธ ๋น„์ฆˆ๋‹ˆ์Šค ์„œ๋ฒ„ ์†Œ์Šค(Spring Boot)

โ”œโ”€โ”€ ๐Ÿ“‚back-chat ๐Ÿ—‚ ๋ฐฑ์—”๋“œ ์ฑ„ํŒ… ์„œ๋ฒ„ ์†Œ์Šค (Ruby on Rails)

โ”œโ”€โ”€ ๐Ÿ“‚ai ๐Ÿ—‚ KuKu ์ฑ„ํŒ… ๋ด‡ ์†Œ์Šค

โ””โ”€โ”€ ๐Ÿ“•Readme.md

8. ์‚ฌ์šฉ๋ฒ•

Frontend

1. ํ”Œ๋Ÿฌํ„ฐ ์„ค์น˜

  1. Flutter ๊ณต์‹ ์›น์‚ฌ์ดํŠธ(https://flutter.dev)์— ์ ‘์†
  2. Get Started๋ฅผ ํด๋ฆญํ•˜์—ฌ ์„ค์น˜ ๊ฐ€์ด๋“œ๋ฅผ ๋”ฐ๋ผ ์„ค์น˜
  3. ์„ค์น˜๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด, ํ„ฐ๋ฏธ๋„ ๋˜๋Š” ์ปค๋งจ๋“œ ํ”„๋กฌํ”„ํŠธ๋ฅผ ์—ด๊ณ  flutter doctor ๋ช…๋ น์–ด๋ฅผ ์‹คํ–‰ํ•˜์—ฌ ์„ค์น˜๊ฐ€ ์˜ฌ๋ฐ”๋ฅด๊ฒŒ ๋˜์—ˆ๋Š”์ง€ ํ™•์ธ

2. ํ”„๋กœ์ ํŠธ ๋””๋ ‰ํ† ๋ฆฌ ์ด๋™

cd front/capstone_front

3. ํ”Œ๋Ÿฌํ„ฐ ํŒจํ‚ค์ง€ ์„ค์น˜

flutter pub get

4. ํ”„๋กœ์ ํŠธ ์‹คํ–‰

flutter run


Backend

[!NOTE] ๋„์ปค๊ฐ€ ์„ค์น˜๋œ ํ™˜๊ฒฝ์—์„œ๋งŒ ์ง„ํ–‰์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

.env.example์„ ๋ฐ”ํƒ•์œผ๋กœ .env๋ฅผ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. ๊ทธ ๋‹ค์Œ

docker-compose up -d

๋ฅผ ํ†ตํ•ด docker compose๋ฅผ ํ†ตํ•˜์—ฌ ์‹คํ–‰ํ•˜์‹œ๋ฉด ๋ฉ๋‹ˆ๋‹ค. ์ด๋ฏธ์ง€๋Š” ๋ชจ๋‘ Dockerhub์— ์—…๋กœ๋“œ ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.


AI

  1. git clone https://github.com/kookmin-sw/capstone-2024-30.git
  2. cd YOUR PATH/ai/
  3. pip install -r requirements.txt
  4. ๋ฒกํ„ฐ ์ €์žฅ์†Œ FAISS ํด๋”๋ฅผ /ai ์— ์œ„์น˜ ๋‹ค์šด๋กœ๋“œ ๋งํฌ
  5. python run_chatbot.py


9. ๊ธฐํƒ€

์ฑ—๋ด‡ ์ฃผ์š” ์ˆ˜์ง‘ ๋ฐ์ดํ„ฐ ์ถœ์ฒ˜

Metrics

RAGAS