diff --git a/README.md b/README.md index a8f46a9..1ff9264 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,199 @@ -## sopkathon-client-client +
-- React + TypeScript -- @emotion/styled -- eslint (최소한으로, 국룰세팅) -- stylelint(X), 대신 PostCss Sorting 익스텐션 사용 +

To Zero

-### branch +서비스대표-이미지 +
퀴즈를 통해 향하는 너와 나 사이의 거리 0km, To Zero -- main (배포용) -- develop (작업용) -- TaeSeungYoo -- JeongAnJang -- SinJiYun +친해지고 싶지만 계기와 명분이 부족한 이들에게, 성향 퀴즈 문답을 통해 상대방을 알아가며 최종적으로 친해질 기회를 마련해주는 서비스
+
-### node version +

✨ 주요 기능

-- 20.13.1 +

1️⃣ 내 퀴즈 만들기

+내 퀴즈 만들기-대표이미지 +
내 취향 관련 퀴즈를 만들어 다른 사용자들이 풀도록 하고, 다 맞춘 상대방의 정보를 볼 수 있다.
+ +

2️⃣ 다른 사람 퀴즈 풀기

+다른 사람 퀴즈 풀기-대표이미지 +
친해지고 싶은 사람의 퀴즈를 풀고, 다 일치하면 상대방에게 내 이름과 인스타 아이디전달 할 수 있다.
+ +

👥 Team

+ + + + + + + + + + + + + + + + + +
+ + gudusolProfile +
+ gudusol +
+
+ + ExceptAnyoneProfile +
+ ExceptAnyone +
+
+ + sinji2102Profile +
+ sinji2102 +
+
+ 유태승
+
+ 장정안
+
+ 윤신지
+
+ 메인 페이지
+ 마이페이지
+ 결과 확인 페이지
+
+ 로그인/회원가입
+
+ 퀴즈 생성 페이지
+ 퀴즈 푸는 페이지
+
+ +

🛠 기술스택

+ +
+ + + + + +
+ + + +
+
+ +
+ +

📄 컨벤션 및 브랜치 전략

+ +

컨벤션

+
  • 해커톤의 특성 상 빠른 작업을 위해, css 컨벤션 등은 따로 정하지 않았습니다.
  • +
    + +| 커밋 컨벤션 | 용도 | +| ----------- | ------------------------ | +| feat | 새 기능 추가 | +| fix | 오류 수정 | +| chore | 간단한 수정 및 파일 추가 | +| refactor | 리팩토링 | +| style | 코드 스타일 수정 | + +
    + + +

    브랜치 전략

    + +
  • 브랜치 또한 해커톤의 특성에 맞춰 빠른 개발을 위해 기능별로 브랜치를 작업하지 않고 한 사람 당 한 개의 브랜치를 가지고 작업하기로 결정하였습니다.
  • +
  • 같은 이유로, PR을 작성하지 않는 동시에 develop에서 merge 시 충돌을 예방하기 위해 브랜치 merge 방식을 정하였습니다.
  • +
    + +1. 각자 이름 브랜치에서 작업 +2. 작업 완료 후 develop → 이름브랜치 방향으로 머지 +3. 2번 과정에서 충돌이 생기면 충돌 처리(각자 이름 브랜치에서 충돌 처리) + 1. 충돌 처리 중 다른 사람이 머지했을 수도 있으므로 혹시모르니 develop → 이름 한번 더 +4. 이름브랜치 → develop 머지 + +
    + +| 브랜치 이름 | 용도 | +| ----------- | --------------- | +| main | 배포용 | +| develop | 작업용 | +| TaeSeungYoo | 작업용 - 유태승 | +| JeongAnJang | 작업용 - 장정안 | +| SinJiYun | 작업용 - 윤신지 | + +
    + +

    📁 폴더 구조

    + +``` +┣ 📦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 +``` + +

    우리조 그라운드 룰

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

    새싹 웨비 Before and After

    +

    Before

    + +![KakaoTalk_20240518_223247808](https://github.com/SOPT-Hackathon-Web4/sopkathon-client/assets/66528589/409ce92f-ca27-4dbe-a682-148cd0391068) + +웨비 팀원들 사진 (before) + +

    After

    +웨비 팀원들 사진 (after) diff --git a/package.json b/package.json index eca2f1c..d1b6b48 100644 --- a/package.json +++ b/package.json @@ -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": { diff --git a/src/components/Button/test.tsx b/src/components/Button/test.tsx new file mode 100644 index 0000000..114ea6b --- /dev/null +++ b/src/components/Button/test.tsx @@ -0,0 +1,11 @@ +import React from 'react' + +const test = () => { + return ( +
    + +
    + ) +} + +export default test diff --git a/yarn.lock b/yarn.lock index 295947d..58000cc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -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" @@ -1902,6 +1907,13 @@ react-router@6.23.1: 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"