team-wequiz / wequiz

Shall We Quiz?😆 AI가 생성한 퀴즈를 친구들과 함께 푸는 서비스

🎲 Shall we quiz?... Click here!

🌈 Introduction Page

📝 Send Feedback

🤔 Overview

AI가 생성한 퀴즈를 친구들과 함께 푸는 서비스

🖱️ Usage

1. PDF 자료를 퀴즈로 변환

유저가 pdf 파일을 입력하면 내용을 파싱 및 벡터화 하여 문서 내용을 기반으로 LLM이 퀴즈를 생성합니다.

2. 퀴즈 방 생성

사용자들이 해당 퀴즈를 풀어볼 수 있는 방을 생성합니다.
간단한 이모지 및 채팅으로 의사소통을 할 수 있습니다.

3. 실시간 퀴즈 풀기

생성된 방에서 게임이 시작되면, 사용자는 실시간으로 퀴즈를 풀어볼 수 있습니다.
문제 풀이는 순서대로 진행되며, 과반수가 해당 문제를 풀었을 경우 짧은 카운트 다운 후 다음 문제로 넘어갑니다.
실시간으로 정답 여부에 따라 참여자들에게 점수가 부여됩니다.
간단한 이모지로 의사소통을 할 수 있습니다.

4. 정답 공유

퀴즈가 모두 끝난 후, 최종 성적표가 제공됩니다.
사용자는 서로가 작성한 답을 공유할 수 있으며, 이에 대한 토론을 나눌 수 있습니다.

🎨 User Interface

시작 페이지	메인 로비	방 만들기
방 접속	퀴즈 풀이	정답 확인

🛠️ Architecture

전체 아키텍처

CI / CD

🎮 Demo

📝 Documents

• 포스터
• 수행결과 보고서
• 발표 자료

🚀 Team

Team WeQuiz
박규연(팀장)	심재민	안금장	김우림	배준형
🤖	⚙️	⚙️	🎨	🎨
ML Engineer	Back-end Developer	Back-end Developer	Front-end Developer	Front-end Developer

---

2024-1 KMUCS 캡스톤디자인 | Copyright 2024. WeQuiz All rights reserved.

wequiz's Issues

[FE] 폴더 구조 및 내용 재구성

개요

기획 변경에 따른 쓰지 않을 페이지, 컴포넌트 정리 및 폴더 정리

작업 내용

요구사항 상세 작성

• 컴포넌트 정리
• 페이지 정리

참고

링크

[FE] eslint ci/cd 적용

[BE] 구글 소셜로그인 구현

개요

• 구글 소셜로그인 구현

작업 내용

참고

링크

[FE] 파일 업로드 구현

개요

[FE] 파일 업로드 구현

작업 내용

클라이언트에서 업로드 받은 파일을 AWS S3 URL로 반환하여 서버에 업로드

• 파일 업로드
• AWS S3 연동
• 서버로 반환
• msw 걷어내기, next route handler 통한 mock 구현

참고

[FE] 초기 설정 및 애니메이션 구현

내용

(2024.01.31 ~ 2024.02.03)
챗봇 프로세스 페이지의 애니메이션 구현

작업 내용

• #24
• �버튼 애니메이션
• 페이지 전환 애니메이션

참고 사항

[BE] 토큰을 통해 유저 식별하는 Argument Resolver

개요

• 토큰을 통해 유저 식별하는 Argument Resolver 관련 작업 구현

작업 내용

• 헤더로 받아온 JWT에서 유저를 식별하는 작업

[BE] Player Entity 구현

개요

Player Entity 구현

작업 내용

• Player Entity 구현

[FE] VE 초기 설정, 메인, 프로세스 페이지 마크업

내용
초기 설정
메인, 프로세스 페이지 구현

작업 내용

• VE 초기설정
• 메인, 프로세스 페이지 구현
  참고 사항

[BE] Security config 추가 및 jwt filter 를 통한 인가 작업

개요

• Spring Security config 추가 및 jwt filter 를 통한 인가 작업

작업 내용

• csrf 방지

• Form 로그인 방지

• http basic 인증방식 방지

• stateless 세션 설정

• jwt filter 를 통한 인가 작업

참고

링크

[BE] Player 테이블 생성 오류 수정

개요

Player 테이블 생성 오류 수정

작업 내용

• Player 테이블 생성 오류 수정

[ML] API로 마이그레이션 작업

개요

utils -> api로 마이그레이션 하는 작업
FastAPI로 전환 함

작업 내용

요구사항 상세 작성

• chain inference api
• gradio client 함수에서 inference api 호출하도록 수정
• pdf2vec convert api

참고

[BE] Issue, PR 템플릿 설정

내용

(2024-01-31 ~ 2024-02-03)
Issue, PR 템플릿 설정

작업 내용

• Issue 템플릿 설정
• PR 템플릿 설정

[FE] eslint, prettier 설정

개요

코드 스타일 통일을 위한 prettier 설정 및 eslint 설정

작업 내용

요구사항 상세 작성

• prettier 설정
• eslint 설정
• #47

참고

링크

[BE] 퀴즈방 생성

개요

퀴즈방 생성 테스트

작업 내용

• 퀴즈방 생성

[ML] PDF 로드, 파싱, 임베딩 벡터화

개요

pdf파일의 내용을 파싱하고 텍스트를 임베딩 벡터로 변환하는 작업

작업 내용

요구사항 상세 작성

• pdf loader 구현
• 임베딩 모델 연결 및 벡터화
• faiss(임시 db)로 테스트

참고

영구적인 db는 어떻게 할 지 고민 중.
dto도 어떻게 할 지 구상해야함.

[ML] 파일 전달받기 구현

개요

s3의 파일을 가져오고 이걸 pymupdf가 읽을 수 있도록 수정합니다
PDF 파일을 여러개 올릴 수 있도록 수정합니다

작업 내용

요구사항 상세 작성

• s3 링크로 파일 가져오도록 구현
• pdf 파일 여러개

참고

langchain-ai/langchain#13638

[FE] 파일 멀티 업로드

개요

멀티 업로드 구현

작업 내용

• 멀티 업로드

참고

링크

[BE] ERD 그리기

개요

ERD 작성!!

작업 내용

• 백엔드단 ERD 작성
• ML DB랑 관계 확인

참고

2/17 오후 6:00 디스코드 예정

[FE] MSW 세팅, 리팩토링

개요

MSW를 활용한 목 서버 구현, 리팩토링

작업 내용

• MSW 서버 세팅
• main 페이지 컴포넌트화, 폴더 구조 리팩토링

참고

[FE] 모달 컴포넌트 제작

개요

공용으로 사용할 모달 컴포넌트 구현

작업 내용

• 공용으로 쓸 모달 컴포넌트 + hook 제작

참고

링크

📝 FE 리드미 재수정

작업내용

• 프론트 리드미 재수정

참고사항

• #5

[ML] 폴더 재구조화

개요

FastAPI로 넘어가기 전에 폴더 재구조화

작업 내용

요구사항 상세 작성

• 폴더 재구조화

참고

ㅠ.ㅠ

ML 리드미 수정

내용

ML repo를 오픈한 기념으로 리드미를 정리해봅니다

작업 내용

• ML repo 파기
• ML README 정리

[BE] Exception Handling

개요

• exception handling 구현

작업 내용

참고

링크

[BE] 이메일 인증 구현

개요

이메일 인증 구현

작업 내용

• 인증코드 발송
• 인증 확인
• 인증번호 유효기간 설정

[FE] 초기설정

내용

(2024.01.31 ~ 2024.02.04)
crn을 활용한 초기설정

작업 내용

• next 앱 설정

참고 사항

[BE] JWT를 이용한 Authentication 구현

개요

• JWT를 이용한 Authentication 구현

작업 내용

• 로그인 / 로그아웃
• 회원가입
• Redis 세팅

[BE] 스프링부트 초기 설정

내용

(2024-01-31 ~ 2024-02-03)
스프링부트 개발 환경 설정

작업 내용

• 스프링부트 초기 설정

FE 리드미 수정

내용

FE 리드미 오픈!

작업 내용

• 리드미 작성

참고 사항

기획 구체화

개요

MVP 외 기획 구체화!!

작업 내용

• 커뮤니티, 마켓 기능
• 학습 분석
• 자잘한 기능들

[FE] Storybook, Text Field 공통 컴포넌트 작성

개요

방만들기 페이지 구현 합니다.

작업 내용

• �Text Field 공통 컴포넌트 작성
• storybook 추가

참고

링크

버튼 애니메이션

[FE] 챗봇 리스트 페이지 구현

내용

(2024.01.31 ~ 2024.02.03)
챗봇 리스트 페이지 작업

작업 내용

• 챗봇리스트 카드 리스트로 구현
• 그리드 레이아웃으로 시도

참고 사항

[ML] pdf 문서 파싱 API 수정 및 s3 접근

개요

파싱한 문서를 s3에 저장하는 파이프라인 구현

작업 내용

• (랭체인 버전업 이후 발생한;) pdf 파싱 에러 수정
  
• pdf2vec 클래스 용도에 따라 두 가지 클래스로 분리 (split, vector)
• s3에 직접 액세스 해서 파일 읽기

참고

stand alone vector indices: FAISS 사용

예상 프로세스

1. 문서를 받아 vector index 생성
2. 이를 이용해서 문제, 문서 메타정보 생성
   1. 문서 메타 정보: 생성자, 생성날짜, 문서 제목, 문서 요약 등
   2. 문서 메타 정보는 로그 마냥 적재할 예정
3. vector index를 임시 저장 (퀴즈방이 종료될 때까지)
4. 퀴즈방 종료 후 index 가져와서 채점
5. vector index 삭제

[FE] 메인 로비 구현

개요

메인 로비 페이지를 구현합니다.

작업 내용

요구사항 상세 작성

• 방 슬롯 리스트 컴포넌트
• hover효과 적용

참고

링크

[BE] User 도메인 구현

개요

• User 도메인 구현

작업 내용

• 아이디
• 비밀번호
• 이메일
• 닉네임
• 나이
• 학교 / 학과 (선택)

참고

링크

[BE] 카카오 소셜로그인 구현

개요

• 카카오 소셜로그인 구현

작업 내용

참고

링크

[BE] User 엔티티 수정

개요

유저 엔티티 수정

작업 내용

• postgres db, 계정 변경
• user 테이블명 users로 변경
• age 삭제
• username, nickname 길이 제한
• nickname unique 설정
• 이메일 인증 여부 컬럼 추가
• 프로필이미지 컬럼 추가

[ML] 챗봇 클라이언트 생성

내용

(2024-01-31 ~ 2024-02-03)
Gradio로 챗봇 클라이언트를 생성합니다.

작업 내용

• 기본 환경 설정
• OpenAI API 연결
• Gradio 생성

[BE] Quizroom Entity 구현

개요

Quizroom Entity 구현

작업 내용

• Quizroom Entity 구현

BE 리드미 재수정

내용

BE 리드미 재수정

작업 내용

• 리드미 재수정

참고 사항

[BE] BaseEntity 생성

개요

• BaseEntity 생성

작업 내용

• 다른 Entity의 기본이 되는 BaseEntity를 만든다. 이후 다른 Entity는 BaseEntity를 상속받아 이용한다.

• BaseEntity 생성

참고

링크

BE 리드미 수정

내용

BE 리드미 오픈!

작업 내용

• 리드미 작성

참고 사항

[ML] 문제 생성 api

개요

문제 생성 api 생성

작업 내용

요구사항 상세 작성

• 객/주/단 타입 입력받도록
• json output parser
  • question, options, answer

참고

링크

:tada: 프로젝트 시작

내용

• 워크스페이스 생성

작업 내용

• be, fe, ml 각각 워크스페이스 생성

[FE] 업로드 후 처리, 멀티파트 구현

개요

스트림 방식과 멀티파트 방식을 나눠서 구현�

작업 내용

요구사항 상세 작성

• 파일 사이즈 체크
• MULTI PART 구현

참고

https://velog.io/@ryanbae94/Next.js-%EC%97%90%EC%84%9C%EC%9D%98-%EB%8C%80%EC%9A%A9%EB%9F%89-%ED%8C%8C%EC%9D%BC-s3-%EC%97%85%EB%A1%9C%EB%93%9C

[ML] OpenAI API 콜 비용 체크

개요

OpenAI API 콜에 드는 비용을 체크합니다.

작업 내용

• 파일 용량에 따른 임베딩 비용 체크
• 질문 방식에 따른 임베딩 비용 체크

참고

[FE] 메인 잘못 올라간 파일 삭제

개요

�잘못 올라간 파일 삭제..

작업 내용

src/app/globals.cc
src/app/page.module.css
src/next.config.mjs

삭제

• �파일 삭제

참고

[BE] 스프링 초기 설정

내용

(2024-01-31 ~ 2024-02-03)
스프링 부트를 이용한 초기 설정 진행

작업 내용

• 스프링 부트를 이용한 초기 설정

참고

Spring initializer

[BE] CORS 설정

개요

• CORS 설정

작업 내용

요구사항 상세 작성

참고

링크