Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yoonc01 authored Aug 25, 2024
1 parent ff3ea49 commit c279691
Showing 1 changed file with 90 additions and 14 deletions.
104 changes: 90 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,53 @@
# 소프티어 부트캠프 4기 최종 프로젝트
> 현대 소프티어 부트캠프 Team 밟으실 수수숲...
>
> 개발기간: 2024.07.22 ~
> 개발기간: 2024.07.22 ~ 2024.08.25
## Contributors
<table align="center">
<tbody>
<td align="center">
<a href="https://github.com/subsub-e">
<img src="https://avatars.githubusercontent.com/u/55149395?v=4" width="200px;" height="200px;" alt="이승섭"/>
<h3><b>이승섭</b></h3>
<h3><b>FRONTEND</b></h3>
</a>
</td>
<td align="center">
<a href="https://github.com/yoonc01">
<img src="https://avatars.githubusercontent.com/u/143938662?v=4" width="200px;" height="200px;" alt="윤효준"/>
<h3><b>윤효준</b></h3>
<h3><b>FRONTEND</b></h3>
</a>
</td>
<td align="center">
<a href="https://github.com/devchlee12">
<img src="https://avatars.githubusercontent.com/u/101349340?v=4" width="200px;" height="200px;" alt="이찬호"/>
<h3><b>이찬호</b></h3>
<h3><b>BACKEND</b></h3>
</a>
</td>
<td align="center">
<a href="https://github.com/gichan222">
<img src="https://avatars.githubusercontent.com/u/139845008?v=4" width="200px;" height="200px;" alt="김기찬"/>
<h3><b>김기찬</b></h3>
<h3><b>BACKEND</b></h3>
</a>
</td>
</tbody>
</table>


## 목차
1. [프로젝트 소개](#프로젝트-소개)
2. [기술 스택](#기술-스택)
3. [프로젝트 구조](#프로젝트-구조)
4. [컨벤션](#컨벤션)
5. [1차 발표 pdf 링크](#1차-발표-pdf-링크)
6. [Notion 주소](#Notion-주소)
7. [주요 기능](#주요-기능)
8. [배포 주소](#배포-주소)

## 프로젝트 소개
### 신차 소개 이벤트 페이지
### 신차 소개 이벤트 페이지 (https://casper-event.store)
#### 주요 서비스
1. 메인 스토리 이벤트
> - 운전 중 발생할 수 있는 다양한 상황이 제시되고, 아이템 결합(경품 응모) 시 해당 상황을 해결할 수 있는 캐스퍼 EV의 기능 정보를 제공함
Expand All @@ -32,24 +66,56 @@
> - 운전 중 피하고 싶은 상황 월드컵 이벤트 참여 후 해당 상황과 관련된 캐스퍼 EV 기대평 작성
> - 참여 시 메인 스토리 이벤트에 참여할 수 있는 '툴박스' 아이템을 하루에 한 번 제공함
### 신차 소개 이벤트 어드민 페이지 (https://hyundai-admin.store)
#### 주요 서비스
1. 이벤트 페이지 정보 수정
> - 미니 퀴즈 질문 수정
> - 미니 퀴즈 답변 수정
> - 응모 결과 수정
> - 상품 목록 수정
> - 응모 당첨 확률 수정
2. 경품 코드 업로드
> - 선착순 경품 Qr 코드 업로드
> - 응모 당첨 경품 Qr 코드 업로드
3. 이벤트 현황
> - 잔여 상품 수 확인
> - 응모 내역 확인
4. 지표 분석
> - 일자별 가입자 수 변화 추이 확인(Day n Retention)
> - 일자별 방문자 수 확인
5. 1등 추첨

### 시연 영상
https://github.com/user-attachments/assets/94467c6a-4e96-4502-9d78-7df3b3a5f2a1

## 기술 스택
#### Environment
![js](https://img.shields.io/badge/Visual_Studio_Code-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white)
![js](https://img.shields.io/badge/GIT-E44C30?style=for-the-badge&logo=git&logoColor=white)
![js](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)
#### Config
![js](https://img.shields.io/badge/yarn-CB3837?style=for-the-badge&logo=npm&logoColor=white)
![js](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
#### Linters
![js](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)
![js](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E)
#### Development
![js](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=JavaScript&logoColor=white)
![js](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![js](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
#### communication
![js](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)

![js](https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=notion&logoColor=white)
## 프로젝트 구조
```
📦 client
📦 service
├── src
│ ├── api # api 관리
│ │
│ ├── assets # 이미지 등의 정적 파일들
│ │ ├── images
│ │ │
Expand All @@ -62,27 +128,33 @@
│ │ ├── footer
│ │ │
│ │ ├── modal
│ │ │
│ │ ├── sliderMotion
│ │ │
│ │ ├── toastMessage
│ │ │
│ │ └── button
│ │
│ │
│ ├── constants # 정적 데이터 관리
│ │
│ │
│ ├── pages # 라우터 페이지 관리 (Head 정보 및 SSR 관리)
│ │ ├── eventIntro
│ │ │
│ │ ├── joinEvent
│ │ │ ├── worldCup
│ │ │ │
│ │ │ ├── miniQuiz
│ │ │ │
│ │ │ ├── dailyComment
│ │ │ │
│ │ │ └── commentList
│ │ │
│ │ ├── worldCup
│ │ │
│ │ ├── miniQuiz
│ │ │
│ │ └── newCarIntro
│ │
│ ├── hooks # 프로젝트 전역적으로 쓰이는 커스텀 hook
│ │
│ ├── context # 상태 관리 (Context API, Redux 등)
│ ├── context # 상태 관리 (Context API)
│ │
│ ├── styles # 전역적으로 사용하는 폰트, 색깔, spacing 등
│ │ └── global.css
Expand All @@ -92,7 +164,11 @@
│ ├── App.jsx # 앱의 진입점
│ │
│ ├── main.jsx
│ │
│ └── router.jsx
├── .eslintrc.cjs
├── .prettierrc
├── index.html
├── tailwind.config.js
└── vite.config.js
Expand Down

0 comments on commit c279691

Please sign in to comment.