Docs: readme 작성

KJ2B-HandsUp · Aug 15, 2023 · e39fe42 · e39fe42
1 parent 62abfc8
commit e39fe42
Show file tree

Hide file tree

Showing 13 changed files with 81 additions and 1 deletion.
diff --git a/.env b/.env
@@ -1,2 +1,2 @@
-VITE_MEDIASERVER_IP = "https://choijungle.shop"
+VITE_MEDIASERVER_IP = ""
 VITE_LOGINSERVER_IP = "/api"
diff --git a/README.md b/README.md
@@ -1 +1,81 @@
 # HandsUp-client
+
+## 💻 프로젝트 소개
+
+[크래프톤 정글 2기] 나만의 무기 갖기 프로젝트.
+
+웹기반 실시간 모션 인식 런치패드 기억력 대전 게임.
+
+## :calendar: 개발 기간
+
+[23.06.29~23.08.12]
+
+- 23.06.29~23.07.06: 팀형성
+- 23.07.07~23.07.13: 주제 선정/기획
+- 23.07.14~23.07.27: MVP 개발
+- 23.07.28~23.08.10: 폴리싱(완성도 올리기)
+- 23.08.12: 최종발표
+
+## 👋 멤버 구성 및 역할
+
+- @KimCookieYa: 게임 제작 및 UI/UX 및 모션 인식 모델
+- @heekyoung2000: 미디어 서버 구축 및 UI/UX
+- @cocomodo: 소셜 로그인 및 회원정보 DB 관리
+- @Fsbsnw: 미디어 서버/DB 관리 및 UI/UX
+
+## 🌏 개발
+
+### Front-End
+
+- Vite + React.js + Typescript
+- mediapipe
+
+### Back-End
+
+- Node.js + Express.js
+- mediasoup
+- 카카오 로그인 api
+- Dynamo DB
+
+### 배포
+
+- AWS EC2 + Nginx
+
+## 포스터
+
+![포스터](./presentation/HandsUp-포스터.jpg)
+
+## 📱 UI
+
+### 로그인 화면
+
+![로그인](./presentation/HandsUp-로그인화면.png)
+
+### 로비 화면
+
+![로비](./presentation/HandsUp-로비화면.png)
+
+### 튜토리얼 화면
+
+![튜토리얼](./presentation/HandsUp-튜토리얼화면.png)
+![튜토리얼게임](./presentation/HandsUp-튜토리얼게임화면.png)
+
+### 대기실 화면
+
+![대기실](./presentation/HandsUp-대기실화면.png)
+
+### 게임(대전모드) 화면
+
+![대전모드](./presentation/HandsUp-대전모드화면.png)
+![게임](./presentation/HandsUp-게임화면.png)
+![패배](./presentation/HandsUp-패배화면.png)
+
+### 랭킹 화면
+
+![랭킹](./presentation/HandsUp-랭킹화면.png)
+
+## 📚 발표 자료(PPT)
+
+[HandsUp-발표자료](./presentation/HandsUp-발표자료.pdf)
+
+## 최종발표 시연 영상
diff --git a/presentation/HandsUp-게임화면.png b/presentation/HandsUp-게임화면.png
diff --git a/presentation/HandsUp-대기실화면.png b/presentation/HandsUp-대기실화면.png
diff --git a/presentation/HandsUp-대전모드화면.png b/presentation/HandsUp-대전모드화면.png
diff --git a/presentation/HandsUp-랭킹화면.png b/presentation/HandsUp-랭킹화면.png
diff --git a/presentation/HandsUp-로그인화면.png b/presentation/HandsUp-로그인화면.png
diff --git a/presentation/HandsUp-로비화면.png b/presentation/HandsUp-로비화면.png
diff --git a/presentation/HandsUp-발표자료.pdf b/presentation/HandsUp-발표자료.pdf
diff --git a/presentation/HandsUp-튜토리얼게임화면.png b/presentation/HandsUp-튜토리얼게임화면.png
diff --git a/presentation/HandsUp-튜토리얼화면.png b/presentation/HandsUp-튜토리얼화면.png
diff --git a/presentation/HandsUp-패배화면.png b/presentation/HandsUp-패배화면.png
diff --git a/presentation/HandsUp-포스터.jpg b/presentation/HandsUp-포스터.jpg