Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
gudusol committed May 18, 2024
2 parents f97f6e5 + 7d9a10c commit 2d30aac
Show file tree
Hide file tree
Showing 4 changed files with 217 additions and 13 deletions.
206 changes: 193 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,199 @@
## sopkathon-client-client
<div align="center">

- React + TypeScript
- @emotion/styled
- eslint (최소한으로, 국룰세팅)
- stylelint(X), 대신 PostCss Sorting 익스텐션 사용
<h2> To Zero </h2>

### branch
<img src="" alt="서비스대표-이미지" />
<div>퀴즈를 통해 향하는 너와 나 사이의 거리 0km, To Zero

- main (배포용)
- develop (작업용)
- TaeSeungYoo
- JeongAnJang
- SinJiYun
친해지고 싶지만 계기와 명분이 부족한 이들에게, 성향 퀴즈 문답을 통해 상대방을 알아가며 최종적으로 친해질 기회를 마련해주는 서비스 </div>

</div>

### node version
<h2> ✨ 주요 기능 </h2>

- 20.13.1
<h3> 1️⃣ 내 퀴즈 만들기 </h3>
<img src="" alt="내 퀴즈 만들기-대표이미지" />
<div ><strong> 내 취향 관련 퀴즈</strong>를 만들어 다른 사용자들이 풀도록 하고, 다 맞춘 <strong>상대방의 정보</strong>를 볼 수 있다.<br/></div>

<h3> 2️⃣ 다른 사람 퀴즈 풀기 </h3>
<img src="" alt="다른 사람 퀴즈 풀기-대표이미지" />
<div >친해지고 싶은 사람의 <strong>퀴즈를 풀고</strong>, 다 일치하면 상대방에게 <strong>내 이름과 인스타 아이디</strong>를 <strong>전달</strong> 할 수 있다. <br/></div>

<h2> 👥 Team </h2>

<table align="center">
<tr align="center">
<td style="min-width: 150px;">
<a href="https://github.com/gudusol">
<img src="https://github.com/gudusol.png" width="200" alt="gudusolProfile">
<br />
<b>gudusol</b>
</a>
</td>
<td style="min-width: 150px;">
<a href="https://github.com/ExceptAnyone">
<img src="https://github.com/ExceptAnyone.png" width="200" alt="ExceptAnyoneProfile">
<br />
<b>ExceptAnyone</b>
</a>
</td>
<td style="min-width: 150px;">
<a href="https://github.com/sinji2102">
<img src="https://github.com/sinji2102.png" width="200" alt="sinji2102Profile">
<br />
<b>sinji2102</b>
</a>
</td>
</tr>
<tr align="center">
<td>
유태승 <br/>
</td>
<td>
장정안 <br/>
</td>
<td>
윤신지 <br/>
</td>
</tr>
<tr align="center">
<td>
메인 페이지 <br/>
마이페이지 <br/>
결과 확인 페이지 <br/>
</td>
<td>
로그인/회원가입 <br/>
</td>
<td>
퀴즈 생성 페이지 <br/>
퀴즈 푸는 페이지 <br/>
</td>
</tr>
</table>

<h2> 🛠 기술스택 </h2>

<div align=center>
<img src="https://img.shields.io/badge/html5-E34F26?style=for-the-badge&logo=html5&logoColor=white">
<img src="https://img.shields.io/badge/css-1572B6?style=for-the-badge&logo=css3&logoColor=white">
<img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black">
<img src="https://img.shields.io/badge/typescript-3178C6?style=for-the-badge&logo=typescript&logoColor=white">
<img src="https://img.shields.io/badge/react-61DAFB?style=for-the-badge&logo=react&logoColor=black">
<br>

<img src="https://img.shields.io/badge/yarn-2C8EBB?style=for-the-badge&logo=yarn&logoColor=white">
<img src="https://img.shields.io/badge/StyledComponents/emotion-DB7093?style=for-the-badge&logo=styledComponents&logoColor=white">
<br>
</div>

<br/>

<h2> 📄 컨벤션 및 브랜치 전략 </h2>
<!-- (노션 링크 또는 표로 작성) -->
<h3>컨벤션</h3>
<li> 해커톤의 특성 상 빠른 작업을 위해, css 컨벤션 등은 따로 정하지 않았습니다.</li>
<br/>

| 커밋 컨벤션 | 용도 |
| ----------- | ------------------------ |
| feat | 새 기능 추가 |
| fix | 오류 수정 |
| chore | 간단한 수정 및 파일 추가 |
| refactor | 리팩토링 |
| style | 코드 스타일 수정 |

<br/>

<!-- <a href="" /> -->
<h3>브랜치 전략</h3>

<li>브랜치 또한 해커톤의 특성에 맞춰 빠른 개발을 위해 기능별로 브랜치를 작업하지 않고 한 사람 당 한 개의 브랜치를 가지고 작업하기로 결정하였습니다.</li>
<li>같은 이유로, PR을 작성하지 않는 동시에 develop에서 merge 시 충돌을 예방하기 위해 브랜치 merge 방식을 정하였습니다.</li>
</br>

1. 각자 이름 브랜치에서 작업
2. 작업 완료 후 develop → 이름브랜치 방향으로 머지
3. 2번 과정에서 충돌이 생기면 충돌 처리(각자 이름 브랜치에서 충돌 처리)
1. 충돌 처리 중 다른 사람이 머지했을 수도 있으므로 혹시모르니 develop → 이름 한번 더
4. 이름브랜치 → develop 머지

<br />

| 브랜치 이름 | 용도 |
| ----------- | --------------- |
| main | 배포용 |
| develop | 작업용 |
| TaeSeungYoo | 작업용 - 유태승 |
| JeongAnJang | 작업용 - 장정안 |
| SinJiYun | 작업용 - 윤신지 |

<br/>

<h2> 📁 폴더 구조 </h2>

```
┣ 📦public
┣ 📂svg
┃ ┣ 📜ic_artist1.svg
┃ ┣ 📜ic_brunch-logo.svg
┃ ┗ 📜ic_subscribe.svg
┗ 📜vite.svg
┣ 📦src
┣ 📂apis
┃ ┣ 📂article
┃ ┃ ┣ 📜getArticle.ts
┃ ┃ ┣ 📜index.ts
┃ ┃ ┗ 📜postArticle.ts
┃ ┗ 📜index.ts
┣ 📂assets
┃ ┣ 📂svg
┃ ┃ ┣ 📜IcArtist1.tsx
┃ ┃ ┣ 📜IcBrunchLogo.tsx
┃ ┃ ┣ 📜IcSubscribe.tsx
┃ ┃ ┗ 📜index.ts
┃ ┣ 📜custom.d.ts
┃ ┗ 📜react.svg
┣ 📂components
┃ ┣ 📂Button
┃ ┃ ┣ 📜index.tsx
┃ ┃ ┗ 📜test.tsx
┃ ┗ 📜index.ts
┣ 📂pages
┃ ┣ 📂dev
┃ ┃ ┗ 📜Dev.tsx
┃ ┣ 📂home
┃ ┃ ┗ 📜Home.tsx
┃ ┗ 📜index.ts
┣ 📂styles
┃ ┣ 📜emotion.d.ts
┃ ┣ 📜generator.ts
┃ ┣ 📜global.ts
┃ ┣ 📜reset.ts
┃ ┗ 📜theme.ts
┣ 📂typings
┃ ┗ 📜commonType.ts
┣ 📂utils
┃ ┗ 📜util.ts
┣ 📜App.tsx
┣ 📜main.tsx
┣ 📜routes.tsx
┗ 📜vite-env.d.ts
```

<h3>우리조 그라운드 룰</h3>

1. 서로에게 상처가 되지 않도록 둥글둥글하게 말하기!
2. 모르는게 있으면 바로바로 물어보고, 상세하게 설명해주기!
3. 쫄지말고 적극적인 의견을 제시하기!
4. 재밌게 진행하기!

<h2> 새싹 웨비 Before and After</h2>
<h3>Before</h3>

![KakaoTalk_20240518_223247808](https://github.com/SOPT-Hackathon-Web4/sopkathon-client/assets/66528589/409ce92f-ca27-4dbe-a682-148cd0391068)

웨비 팀원들 사진 (before)

<h3>After</h3>
<img src="" alt="웨비 팀원들 사진 (after)"/>
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-router-dom": "^6.23.1",
"react-toastify": "^10.0.5",
"vite-tsconfig-paths": "^4.3.2"
},
"devDependencies": {
Expand Down
11 changes: 11 additions & 0 deletions src/components/Button/test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import React from 'react'

const test = () => {
return (
<div>

</div>
)
}

export default test
12 changes: 12 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1045,6 +1045,11 @@ chalk@^4.0.0:
ansi-styles "^4.1.0"
supports-color "^7.1.0"

clsx@^2.1.0:
version "2.1.1"
resolved "https://registry.yarnpkg.com/clsx/-/clsx-2.1.1.tgz#eed397c9fd8bd882bfb18deab7102049a2f32999"
integrity sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==

color-convert@^1.9.0:
version "1.9.3"
resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8"
Expand Down Expand Up @@ -1902,6 +1907,13 @@ [email protected]:
dependencies:
"@remix-run/router" "1.16.1"

react-toastify@^10.0.5:
version "10.0.5"
resolved "https://registry.yarnpkg.com/react-toastify/-/react-toastify-10.0.5.tgz#6b8f8386060c5c856239f3036d1e76874ce3bd1e"
integrity sha512-mNKt2jBXJg4O7pSdbNUfDdTsK9FIdikfsIE/yUCxbAEXl4HMyJaivrVFcn3Elvt5xvCQYhUZm+hqTIu1UXM3Pw==
dependencies:
clsx "^2.1.0"

react@^18.2.0:
version "18.3.1"
resolved "https://registry.yarnpkg.com/react/-/react-18.3.1.tgz#49ab892009c53933625bd16b2533fc754cab2891"
Expand Down

0 comments on commit 2d30aac

Please sign in to comment.