Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #102

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 170 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,76 +1,202 @@
# Welcome to GitHub
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/omXkVCQu)
[![Open in Visual Studio Code](https://classroom.github.com/assets/open-in-vscode-2e0aaae1b6195c2367325f4f02e2d04e9abb55f0b24a779b69b11b9e10269abc.svg)](https://classroom.github.com/online_ide?assignment_repo_id=13961746&assignment_repo_type=AssignmentRepo)

캡스톤 팀 생성을 축하합니다.
## 🤖 프로젝트 소개

## 팀소개 및 페이지를 꾸며주세요.
- github pages : https://kookmin-sw.github.io/capstone-2024-24/
- 국민대 2024년 캡스톤 24조 https://github.com/kookmin-sw/capstone-2024-24
- 중간보고서 : https://drive.google.com/file/d/16NaXpkgVccnvjZIrgBijLE6NKX_uG9iI/view?usp=sharing
- 중간발표자료 : https://drive.google.com/file/d/1uSfNx9Hp3RWLK9qVZHUtFuv0Xsn-snNT/view?usp=sharing
- 수행결과보고서 : https://drive.google.com/file/d/1IbI-sa29dC_Hl3WDFYEpwIP4-hk6hBiu/view?usp=sharing
- 포스터 : https://drive.google.com/file/d/14_RdeUE0qICHoIB8ew2KacO1oV-oKbmF/view?usp=sharing

## 🤖 AI 기반 대화형 키오스크, 주미(Jumi)

- 프로젝트 소개
- 프로젝트 설치방법 및 데모, 사용방법, 프리뷰등을 readme.md에 작성.
- Api나 사용방법등 내용이 많을경우 wiki에 꾸미고 링크 추가.
당신만의 점원 '주미(Jumi)'

- 팀페이지 꾸미기
- 프로젝트 소개 및 팀원 소개
- index.md 예시보고 수정.
키오스크 사용이 복잡하고 어렵지 않으신가요?
AI와의 대화를 통해 더 간편하고, 쉽고, 자신있게 키오스크를 사용하실 수 있습니다. 주미(Jumi)를 통해 매장에서의 불편함을 줄여보세요! 😆

- GitHub Pages 리파지토리 Settings > Options > GitHub Pages
- Source를 marster branch
- Theme Chooser에서 태마선택
- 수정후 팀페이지 확인하여 점검.
![Jumi_Logo](https://github.com/kookmin-sw/capstone-2024-24/assets/93641814/19762b3a-6bf8-4d6f-bcbd-824c30cd62c6)

**팀페이지 주소** -> https://kookmin-sw.github.io/ '{{자신의 리파지토리 아이디}}'
서울디지털재단이 발표한 ‘서울시민 디지털 역량 실태조사’에 따르면 55세 이상 고령층의 45.8%만 키오스크 이용 경험이 있다고 응답했습니다. 55세 미만에서 같은 답변이 94.1%였던 것에 비하면 절반에도 못 미치는 수준입니다. 실제로 고령 소비자층은 키오스크를 이용하며 불편한 점으로 ‘복잡한 단계 및 화면 조작’, ‘주문 상품에 대한 문의 불가’ 등을 꼽았습니다.(한국소비자원 설문조사)

**예시)** 2023년 0조 https://kookmin-sw.github.io/capstone-2023-00/
주미(Jumi)는 기존의 중노년층이나 가게에 처음오는 사람 등 해당 매장의 키오스크 사용에 미숙한 점이 많아 설명과 도움이 필요한 사람들을 대상으로 개발 중에 있습니다.

대화를 통해 기존 점원들이 진행하던 주문뿐아니라 메뉴 설명, 매장설명 및 손님응대를 ai인 주미가 진행하므로써 손님은 자신만을 위한 작은 테이블위 담당 직원이 생기는 것이고 매장은 더 적은 비용으로 서비스 품질을 늘릴 수 있는 기회가 될 것입니다.

## 내용에 아래와 같은 내용들을 추가하세요.
---

### 1. 프로잭트 소개
Introducing 'Jumi', Your Own Clerk!

프로젝트
Are you finding kiosk usage complex and challenging? With Jumi, you can interact more conveniently, easily, and confidently through AI conversation for smoother kiosk navigation. Let's reduce the inconvenience at your store! 😆

### 2. 소개 영상
According to the 'Seoul Citizen Digital Competency Survey' released by the Seoul Digital Foundation, only 45.8% of the elderly aged 55 and above responded that they have experience using kiosks. This figure is significantly lower than the 94.1% response from those under 55 years old. In fact, elderly consumers cited 'complex steps and screen manipulation' and 'inability to inquire about ordered items' as inconvenient aspects of using kiosks (Korea Consumer Agency survey).

프로젝트 소개하는 영상을 추가하세요
Jumi is being developed to assist those who are unfamiliar with using kiosks, such as the middle-aged and elderly, or those visiting a store for the first time, by providing explanations and assistance.

### 3. 팀 소개
Through conversation, Jumi not only handles orders like traditional staff but also provides menu explanations, store guidance, and customer service. This creates a personalized experience for the customer, akin to having a dedicated staff member at their service, while offering the store an opportunity to enhance service quality at lower costs.

팀을 소개하세요.
## 🤖 포스터

팀원정보 및 담당이나 사진 및 SNS를 이용하여 소개하세요.
![2024캡스톤_24팀_포스터_png](https://github.com/kookmin-sw/capstone-2024-24/assets/57210308/19a692e2-3763-43d2-bb34-65529f43f3e8)

### 4. 사용법

소스코드제출시 설치법이나 사용법을 작성하세요.
포스터(PDF) 다운로드 링크 : [2024캡스톤_24팀_포스터.pdf](https://github.com/kookmin-sw/capstone-2024-24/files/15415655/2024._24._.pdf)

### 5. 기타

추가적인 내용은 자유롭게 작성하세요.

## 🤖 소개 영상

## Markdown을 사용하여 내용꾸미기
https://github.com/kookmin-sw/capstone-2024-24/assets/93641814/36993f9d-da9d-41c4-b8c0-489f13e212bc

Markdown은 작문을 스타일링하기위한 가볍고 사용하기 쉬운 구문입니다. 여기에는 다음을위한 규칙이 포함됩니다.

```markdown
Syntax highlighted code block
## 🤖 프로젝트 기능

# Header 1
## Header 2
### Header 3
### Android

- Bulleted
- List
#### AI 직원과의 음성 대화
대화하기 버튼을 통해 언제든 Jumi와 대화를 주고 받을 수 있어요. Jumi의 대답은 음성으로 함께 제공돼요.

1. Numbered
2. List
#### 대표 예시 질문 제공
대화 화면 하단에 대표 예시 질문을 제공하여 Jumi에게 어떤 질문을 해야하는지 낯선 사용자에게 가이드를 제공해요.

**Bold** and _Italic_ and `Code` text
#### 일반 키오스크 조작
대화 모드와 일반 모드를 자유롭게 사용할 수 있어요. 기존 키오스크가 편한 사용자들을 위해 터치 방식으로 조작할 수 있어요.

[Link](url) and ![Image](src)
```
#### 고령층을 고려한 UX/UI
고령층이 인식하기 쉽게 기존 키오스크보다 큰 텍스트 및 이미지를 제공해요. 최소한의 페이지 구성을 통해 화면 이동과 주문 과정을 간소화했어요.

자세한 내용은 [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
### Admin

### Support or Contact
#### 매장/키오스크 관리
관리자 페이지에서 매장과 키오스크의 메뉴를 추가/삭제할 수 있어요. 사용자는 관리자가 설정한 영역 내에서 키오스크를 사용할 수 있어요.

readme 파일 생성에 추가적인 도움이 필요하면 [도움말](https://help.github.com/articles/about-readmes/) 이나 [contact support](https://github.com/contact) 을 이용하세요.
#### Jumi 학습
직접 AI에게 프롬프트를 입력하여 관리자가 원하는대로 Jumi를 커스텀할 수 있어요. 사용자는 관리자가 원하는 방향의 질문에 대한 답을 얻을 수 있어요.

#### 통계자료
관리자 페이지에서 매장의 매출 내역을 확인하고 비교할 수 있어요. 다양한 그래프를 통해 관리자가 편하게 동향을 파악할 수 있어요.

#### 주문내역 확인
관리자가 주문내역과 고객의 대화 내역을 확인/추적하여 주미가 고객 요구에 적절한 대응을 했는지 확인할 수 있어요.

## 🤖 폴더구조

현재 테스트 파일로 각각의 폴더 내의 안내를 참고해 주세요.

- (frontend) 관리자 페이지
- (android) 키오스크 앱 동작 및 구성
- (backend) 데이터 및 LLM에 접근 가능한 서버 엔드포인트 (API) 구현
- (ai) voice detecting 기능과 whisper를 연결하여, 말을 인식하여 text로 출력하는 기능, text를 받아 점원 주미로써 claude3 sonnet이 동작하여 답변을 생성하도록 하는 함수

## 🤖 시스템 인포그래픽
<img width="719" alt="image" src="https://github.com/kookmin-sw/capstone-2024-24/assets/57210308/ea8b683d-47f7-4366-83ab-26804dffa1b3">



## 🤖 팀원 소개
<table>
<tr align="center">
<td style="min-width: 150px;">
<a href="https://github.com/Roel4990">
<img src="https://github.com/kookmin-sw/capstone-2024-24/assets/93641814/4977f984-0166-402e-923f-dc5329e0e310" width="100">
<br />
<b>안세홍</b>
</a>
<br/>
20181640
</td>
<td style="min-width: 150px;">
<a href="https://github.com/Eonji-sw">
<img src="https://github.com/kookmin-sw/capstone-2024-24/assets/93641814/3abed7fd-7d59-4147-a50d-52a6ac8840b6"
width="100">
<br />
<b>김언지</b>
</a>
<br/>
20212979
</td>
<td style="min-width: 150px;">
<a href="https://github.com/devkaspee">
<img src="https://github.com/kookmin-sw/capstone-2024-24/assets/57210308/17035fbe-52d6-41dd-b69e-154ab19fcfb9" width="100">
<br />
<b>임호준</b>
</a>
<br/>
20181685
</td>
<td style="min-width: 150px;">
<a href="https://github.com/kwonbooyeon">
<img src="https://github.com/kookmin-sw/capstone-2024-24/assets/93641814/fbdded38-3b49-4268-8838-4f6294c63313" width="100">
<br />
<b>권부연</b>
</a>
<br/>
20203030
</td>
</tr>
<tr align="center">
<td>
Front-end(web), TL
</td>
<td>
Front-end(android)
</td>
<td>
Back-end
</td>
<td>
AI
</td>
</tr>
</table>

## 🛠 기술 스택

### 🖥 Frontend
|역할|종류|
|-|-|
|Library|<img alt="RED" src ="https://img.shields.io/badge/REACT-61DAFB.svg?&style=for-the-badge&logo=React&logoColor=white"/>|
|UI Framework|![mui](https://img.shields.io/badge/mui-007FFF?style=for-the-badge&logo=mui&logoColor=white)|
|Programming Language|![JavaScript](https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=white)|
|Formatting|![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)|
|Data Fetching|![React Query](https://img.shields.io/badge/-React%20Query-FF4154?style=for-the-badge&logo=react%20query&logoColor=white)|
|Package Manager|![Npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)|
|CI/CD|![Vercel](https://img.shields.io/badge/vercel-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)|
<br />

### 🖥 Android
|역할|종류|
|-|-|
|Development Environment and Tools|![Androidstudio](https://img.shields.io/badge/androidstudio-3DDC84?style=for-the-badge&logo=androidstudio&logoColor=white)|
|Platform|![Android](https://img.shields.io/badge/android-34A853?style=for-the-badge&logo=android&logoColor=white)|
|Programming Language|![Kotlin](https://img.shields.io/badge/kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white)|
<br />

### 🖥 Backend
|역할|종류|
|-|-|
|Framework|![Fastapi](https://img.shields.io/badge/fastapi-009688?style=for-the-badge&logo=fastapi&logoColor=white) ![serverless](https://img.shields.io/badge/serverless-FD5750?style=for-the-badge&logo=serverless&logoColor=white)|
|Database|![MySQL](https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white)|
|Database Service|![amazonrds](https://img.shields.io/badge/amazonrds-527FFF?style=for-the-badge&logo=amazonrds&logoColor=white) ![amazons3](https://img.shields.io/badge/amazons3-569A31?style=for-the-badge&logo=amazons3&logoColor=white)|
|Programming Language|![Python](https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white)|
|CI/CD|![githubactions](https://img.shields.io/badge/githubactions-2088FF?style=for-the-badge&logo=githubactions&logoColor=white)|
<br />

### 🖥 AI
|역할|종류|
|-|-|
|Framework|![pytorch](https://img.shields.io/badge/pytorch-EE4C2C?style=for-the-badge&logo=pytorch&logoColor=white)|
|Programming Language|![Python](https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white)|
<br />


### 🖥 Common
|역할|종류|
|-|-|
|협업 관리|![notion](https://img.shields.io/badge/notion-000000?style=for-the-badge&logo=notion&logoColor=white) ![discord](https://img.shields.io/badge/discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)|
|디자인|![figma](https://img.shields.io/badge/figma-F24E1E?style=for-the-badge&logo=figma&logoColor=white)|
|Version Control|![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)|

<br />