Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jw0097 authored Aug 25, 2024
1 parent dac7e74 commit f474bf6
Showing 1 changed file with 41 additions and 34 deletions.
75 changes: 41 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# 못말리는 현기차팀 FrontEnd

[![HYUNDAI SELTOS EVENT](https://www.hyundaiseltos.site/OGImage.png)](https://www.hyundaiseltos.site/)

## 목차
1. [👥 팀원 소개](#👥-팀원-소개)
2. [🛠️ Tech Stacks](#🛠️-Tech-Stacks)
3. [🤝 협업 전략](#🤝-협업-전략)
4. [📖 그라운드 룰](#📖-그라운드-룰)
5. [Components Architecture Diagram](#Components-Architecture-Diagram)
6. [Route](#Route)
7. [주요 개발 사항](#주요-개발-사항)
8. [링크 모음](#링크-모음)
5. [🗂️ Components Architecture Diagram](#🗂️-Components-Architecture-Diagram)
6. [🗺️ Route](#🗺️-Route)
7. [🚀 주요 개발 사항](#🚀-주요-개발-사항)
8. [🔗 링크 모음](#🔗-링크-모음)

## 👥 팀원 소개
<table >
Expand All @@ -35,12 +37,13 @@

### Development
![react](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![js](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=JavaScript&logoColor=white)
![ts](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)


### Test
![jest]( https://img.shields.io/badge/Jest-323330?style=for-the-badge&logo=Jest&logoColor=white)
![rtl](https://img.shields.io/badge/testing%20library-323330?style=for-the-badge&logo=testing-library&logoColor=red)

<img src="https://img.shields.io/badge/Storybook-FF4785?style=for-the-badge&logo=Storybook&logoColor=white">
### Deploy
![aws](https://img.shields.io/badge/Amazon_AWS_S3-232F3E?style=for-the-badge&logo=amazon-aws&logoColor=white)
![cloud](https://img.shields.io/badge/Amazon_AWS_Cloud-FF9900?style=for-the-badge&logo=amazonaws&logoColor=white)
Expand Down Expand Up @@ -95,16 +98,20 @@ Team9-Podo-FE
├── .github # Feature, PR, Bug template
├── public # public
└── src
├── api # api 호출 Function
├── assets # fonts, images, svg resoucres
├── components # 페이지를 구성하는 components
├── constants # api, message, pagination 및 공통적으로 사용되는 constants
├── hooks # custom hooks
├─- mocks # MSW를 활용한 mock data, handler
├── pages # 페이지를 구성하는 레이아웃
├── providers # Context Provider
├── styles # Global Style
├── utils # date, validator 관련 util 함수
├── common # fonts, images, svg, video resoucres
├── admin # 어드민 페이지
└── client # 이벤트 페이지
├── api # api 호출 Function
├── components # 페이지를 구성하는 components
├── constants # api, message, pagination 및 공통적으로 사용되는 constants
├── hooks # custom hooks
├─- mocks # MSW를 활용한 mock data, handler
├── pages # 페이지를 구성하는 레이아웃
├── providers # Context Provider
├── router # 라우터
├── styles # Global Style
├── types # 타입
├── utils # date, validator 관련 util 함수
```

### Branch Naming
Expand All @@ -113,28 +120,23 @@ feature/{feature-name}
```

## 📖 그라운드 룰
* 월요일 오전에 Product Backlog를 마일스톤으로 작성함
* 매일 10시 데일리 스크럼을 통해 진행상황을 공유하고 Sprint Backlog를 업데이트함
* Product Backlog를 마일스톤으로 작성함
* 매일 10시 데일리 스크럼을 통해 진행상황을 공유함
* 금요일 오전에 main에 dev를 merge함
* 스크럼 내용은 기록으로 남김
* PR은 merge하기 전 서로 리뷰함
* Commit은 Issue task의 작업 크기를 넘지 않도록 함
* 메시지를 확인했다면 최소한 이모지를 사용해서 반응함
* 프로젝트 진행 중, Component Architecture에 수정사항이 생기면 lucid chart에도 수정 사항을 반영함

## Components Architecture Diagram
## 🗂️ Components Architecture Diagram
![Softeer4th_Podo](https://github.com/user-attachments/assets/648c3bba-690e-4742-b689-7106508da049)
[LucidChart](https://lucid.app/lucidchart/54de6901-4a2c-4e7f-9be6-e04ce897e22b/edit?viewport_loc=-4141%2C-2304%2C7416%2C3874%2C0_0&invitationId=inv_1efdb6e5-bc22-4187-98b5-ce5c579189e2)

## Route
## 🗺️ Route

| Page | path | children |
| --- | --- | --- |
| Main | / | |
| Event1 | /event1 | quiz1 |
| | | quiz2 |
| | | quiz3 |
| | | quiz4 |
| Event1 | /event1 |
| Event1Result | /event1/result | |
| Event2 | /event2 | quiz1 |
| | | quiz2 |
Expand All @@ -143,17 +145,22 @@ feature/{feature-name}
| Event2Result | /event2/result | |
| AuthModal | /auth-modal | |

## 주요 개발 사항
- Bundler 설정
- SEO 적용
- TDD
## 🚀 주요 개발 사항
- Bundler 설정 (webpack)
- TDD (jest, storybook)

## 링크 모음
### 기획/디자인
## 🔗 링크 모음
### 🎨 기획/디자인
[Figma](https://www.figma.com/design/OKDklxTfqRuOKwFiXpwwqi/Handoff_%EB%AA%BB%EB%A7%90%EB%A6%AC%EB%8A%94-%ED%98%84%EA%B8%B0%EC%B0%A8~?node-id=0-1&t=UF1RvsAkEytBC7cD-0)

### Meeting Minutes
### 📝 Meeting Minutes
TEAM: [Notion](https://www.notion.so/bside/19054254d3d14ebca54704c52c370e46)

FE: [Notion](https://www.notion.so/bside/4dac5712789243f09ed25a08c1d02670?v=061f3d1be85e4888bfa2769e516364c8)
FE: [Notion](https://www.notion.so/bside/4dac5712789243f09ed25a08c1d02670?v=061f3d1







0 comments on commit f474bf6

Please sign in to comment.