๐ป ์บก์คํค 30์กฐ ๊ฒฐ๊ณผ๋ฌผ ์๊ฐ
[์ต์ข ๋ฐํ ์๋ฃ&ํฌ์คํฐ ๋ฐ ๋ณด๊ณ ์]
[Github]
`ํํธ๋ณ ์์ธํ ๋ด์ฉ์ ๊ฐ ํ๋ก์ ํธ ๋๋ ํ ๋ฆฌ์ ๋งํฌ๋ค์ด ๋ฌธ์๋ฅผ ํ์ธํด์ฃผ์๊ธฐ ๋ฐ๋๋๋ค`
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. ์์ฐ ์์
4. ํ๋ก์ ํธ ๊ธฐ๋ฅ
1๏ธโฃ ๋ฒ์ญ๋ ๊ณต์ง์ฌํญ / ํ์ / ํ๊ต์ ๋ณด ์ ๊ณต
๊ตญ๋ฏผ๋ํ๊ต์์๋ ๊ณต์ง์ฌํญ, ํ์, ํ๊ต์ ๋ณด์ ๋ฒ์ญ์ ์ ์ง์ํ์ง ์์ต๋๋ค. ์ด์๋ฐ๋ผ ์ธ๊ตญ์ธ ์ ํ์๋ค์ ๋งค๋ฒ ๋ฒ์ญ๊ธฐ๋ฅผ ์ฌ์ฉํ์ฌ ํ๊ต์ ๋ํ ์ ๋ณด๋ฅผ ์ป๊ธฐ ๋๋ฌธ์ ์ ๋ณด์ ์ ๊ทผ์ฑ์ด ๋ฎ์ต๋๋ค.
๋ฐ๋ผ์, ์ธ๊ตญ๋ฏผ ์๋น์ค๋ ์ค์ ํ ์ธ์ด์ ๋ง์ถฐ์ ๊ณต์ง์ฌํญ/ํ์/ํ๊ต์ ๋ณด ๋ฒ์ญ๋ณธ์ ์ ๊ณตํฉ๋๋ค.
๋ฒ์ญ๋ ๊ณต์ง์ฌํญ | ๊ณต์ง์ฌํญ ๋ํ ์ผ | ๋ฒ์ญ๋ ํ์์ ๋ณด |
---|---|---|
2๏ธโฃ ์ฑ๋ด ๊ธฐ๋ฅ
๊ตญ๋ฏผ๋ํ๊ต์์๋ ON๊ตญ๋ฏผ ์ฑ๋ด โ์ฟ ๋ฏผ์ดโ๋ฅผ ์๋น์คํ๊ณ ์์ผ๋, ์ฑ๋ฅ์ด ๋งค์ฐ ํํธ์์ต๋๋ค. ๊ฐ๋จํ ์ง๋ฌธ์๋ ๋๋ฌธ์๋ต์ ํ๊ฑฐ๋, ์์ด๋ก ์ง๋ฌธํ๋๋ฐ ํ๊ธ๋ก ๋ต๋ณํ๋ ๋ฑ ์ ํ ์ฑ๋ด์ผ๋ก์์ ๊ธฐ๋ฅ์ ์ํํ์ง ๋ชปํ๊ณ ์์ต๋๋ค.
๋ฐ๋ผ์, ์ธ๊ตญ๋ฏผ์ RAG์ LLM์ ์ฌ์ฉํ์ฌ ๊ตญ๋ฏผ๋ํ๊ต์ ํนํ๋ ๋ต๋ณ์ ์ ๊ณตํ๊ณ ๋ค๊ตญ์ด๋ฅผ ์ง์ํ๋ โKuKuโ ์ฑ๋ด์ ์ ๊ณตํฉ๋๋ค.
๊ตญ๋ฏผ๋ ๊ด๋ จ ์ง๋ฌธ | ๋ค๊ตญ์ด ์ง์ | ์ผ์ ๋ํ |
---|---|---|
3๏ธโฃ ๋ฐ์ ๊ต์ ๊ธฐ๋ฅ
๋ง์ ์ธ๊ตญ์ธ๋ค์ ํ๊ตญ์ ์์ ์ธ์ด ๋ฌธ์ ๋ก ํ๋ค์ดํฉ๋๋ค. ํนํ ํ๊ต ์ํ์ ํ๋ค๋ณด๋ฉด ๋ฐํ๋ฅผ ํ๊ฑฐ๋ ์ผ์์ํ์์ ์์ฌ์ํต์ ํด์ผํ ๋, ๋ณธ์ธ์ ๋ฐ์์ด ์ ํํ์ง ํ์ธํ ๋ฐฉ๋ฒ์ด ์์ด์ ํ๋ค์ดํฉ๋๋ค.
๋ฐ๋ผ์, ์ธ๊ตญ๋ฏผ์ ์์ ์ ๋ฐํ ์คํฌ๋ฆฝํธ๋ฅผ ์ ๋ ฅ์ผ๋ก ๋ฃ์ด์ ๋ฐ์ ํ๊ฐ๋ฅผ ๋ฐ์ ์ ์์ ๋ฟ๋ง ์๋๋ผ, ํ๊ตญ์ ์ผ์์ํ์์ ๋ง์ด ์ฐ์ด๋ ์ฌ๋ฌ ํํ๋ค์ ์ฐ์ตํ ์ ์๋๋กํ์ฌ ํ๊ตญ ์ ํ์ํ์ ๋๊ณ ์ ํฉ๋๋ค.
์ผ์์ํ์ ์์ฃผ์ฐ๋ ์๋ฌธ ์ง์ | ๋ฌธ์ฅ ์ปค์คํ ์ง์ | ๋ฐ์ ํ๊ฐ ์ ๊ณต |
---|---|---|
4๏ธโฃ ํฌํผ ๋งค์นญ ๊ธฐ๋ฅ
๋ง์ ์ธ๊ตญ์ธ๋ค์ด ๋ฏ์ ๋ ์ ์์ ๋ ๋์์ ๋ฐ์ ์ฌ๋์ด ์์ด์ ๋งค์ฐ ํ๋ค์ดํฉ๋๋ค.
๋ฐ๋ผ์, ์ธ๊ตญ๋ฏผ์ ์ธ๊ตญ์ธ๋ค์ ๋์ธ ์ ์๋๋ก ํฌํผ ๋งค์นญ ๊ธฐ๋ฅ์ ์ ๊ณตํฉ๋๋ค. ํ๊ตญ์ธ or ์ค๋ ์ ํ์ํ์ ํ์ฌ ํ๊ตญ ์ํ์ ์ต์ํด์ง ์ธ๊ตญ์ธ ํฌํผ๋ฅผ ๊ตฌํ ์ ์๋๋ก ์ปค๋ฎค๋ํฐ๋ฅผ ์ ๊ณตํฉ๋๋ค.
ํฌํผ ๋ฐ ํฌํผ ๊ฒ์ํ | ๋ํ ์ผ | ์ฑํ |
---|---|---|
5๏ธโฃ Q&A์ FAQ ๊ธฐ๋ฅ
์ ํ์๋ค์ด ํ๊ตญ์ํ์์ ๊ถ๊ธํ ๊ฒ์ ๋ฌผ์ด๋ณผ๋งํ ๊ณณ์ด ๋ง๋ ์น ์๊ณ , ON๊ตญ๋ฏผ์ ์๋ FAQ์ ์กด์ฌ๋ฅผ ์๊ธฐ ์ฝ์ง ์์ต๋๋ค. ํ์ง๋ง, ์ด FAQ ๋ํ ๋ฒ์ญ์ ์ ๊ณตํ์ง ์๊ณ ์์ต๋๋ค.
๋ฐ๋ผ์, ์ธ๊ตญ๋ฏผ์ Q&A ๊ฒ์ํ๊ณผ ๋ค๊ตญ์ด๋ก ๋ฒ์ญ๋ FAQ๋ฅผ ์ ๊ณตํฉ๋๋ค.
Q&A ๊ฒ์ํ | ๋ํ ์ผ | FAQ ์กฐํ |
---|---|---|
5. ํ์ ์๊ฐ
6. ๊ธฐ์ ์คํ
๐ Frontend
์ญํ | ์ข ๋ฅ |
---|---|
Framework | |
Database | |
Programming Language | |
Device |
๐พ Backend
์ญํ | ์ข ๋ฅ |
---|---|
Framework | |
Database | |
Programming Language | |
Test | |
Deploy | |
CI/CD | |
ETC |
๐ป AI
์ญํ | ์ข ๋ฅ |
---|---|
Programming Language | |
Development | |
Technology | |
Test | |
Server |
๐จ Tools
์ญํ | ์ข ๋ฅ |
---|---|
Version Control | |
Cooperation | |
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. ํ๋ฌํฐ ์ค์น
- Flutter ๊ณต์ ์น์ฌ์ดํธ(https://flutter.dev)์ ์ ์
Get Started
๋ฅผ ํด๋ฆญํ์ฌ ์ค์น ๊ฐ์ด๋๋ฅผ ๋ฐ๋ผ ์ค์น- ์ค์น๊ฐ ์๋ฃ๋๋ฉด, ํฐ๋ฏธ๋ ๋๋ ์ปค๋งจ๋ ํ๋กฌํํธ๋ฅผ ์ด๊ณ
flutter doctor
๋ช ๋ น์ด๋ฅผ ์คํํ์ฌ ์ค์น๊ฐ ์ฌ๋ฐ๋ฅด๊ฒ ๋์๋์ง ํ์ธ
2. ํ๋ก์ ํธ ๋๋ ํ ๋ฆฌ ์ด๋
cd front/capstone_front
3. ํ๋ฌํฐ ํจํค์ง ์ค์น
flutter pub get
4. ํ๋ก์ ํธ ์คํ
flutter run
Backend
.env.example
์ ๋ฐํ์ผ๋ก .env
๋ฅผ ์์ฑํฉ๋๋ค. ๊ทธ ๋ค์
docker-compose up -d
๋ฅผ ํตํด docker compose๋ฅผ ํตํ์ฌ ์คํํ์๋ฉด ๋ฉ๋๋ค. ์ด๋ฏธ์ง๋ ๋ชจ๋ Dockerhub์ ์ ๋ก๋ ๋์ด ์์ต๋๋ค.
AI
git clone https://github.com/kookmin-sw/capstone-2024-30.git
cd YOUR PATH/ai/
pip install -r requirements.txt
- ๋ฒกํฐ ์ ์ฅ์ FAISS ํด๋๋ฅผ
/ai
์ ์์น ๋ค์ด๋ก๋ ๋งํฌ python run_chatbot.py
9. ๊ธฐํ
์ฑ๋ด ์ฃผ์ ์์ง ๋ฐ์ดํฐ ์ถ์ฒ
- ๊ตญ๋ฏผ๋ 2023 ์๋ PDF
- ๊ตญ๋ฏผ๋ ์ ์ฒด ๊ณต์ง์ฌํญ
- ๊ตญ๋ฏผ๋ ํํ์ด์ง ๋ํ์๊ฐ
- ๊ตญ๋ฏผ๋ ํํ์ด์ง ๋ํ์ํ
- ๊ตญ๋ฏผ๋ ํํ์ด์ง ํ์ฌ์๋ด
- ๊ตญ๋ฏผ๋ ์ํํธ์จ์ด์ตํฉ๋ํ
- ๊ตญ๋ฏผ๋ ์ํํธ์จ์ด์ตํฉ๋ํ ๊ณต์ง์ฌํญ
- ๊ทธ ์ธ ๋ค์ด๋ฒ ๋ฐ ๊ตฌ๊ธ ๊ธฐํ ์์ง ๋ฐ์ดํฐ