From 3526486e81c9ed1f449db98f617c8058ec5f7efe Mon Sep 17 00:00:00 2001 From: seoAreum <1971236@hansung.ac.kr> Date: Wed, 10 Jan 2024 12:35:25 +0900 Subject: [PATCH 1/4] =?UTF-8?q?docs:=20readme=20=EB=AC=B8=EC=84=9C=20?= =?UTF-8?q?=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 149 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 148 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee635805..87c28b8b 100644 --- a/README.md +++ b/README.md @@ -1 +1,148 @@ -아루밍 비니 쩡우 도리 큐비들 사랑해~❤️ +
+

💌 Lecue 💌

+ +로고 대문 이미지 +
+ +
+ +## 💡서비스 소개 +함께 꾸미며 ✨최애✨에게 진심을 전하는 롤링페이퍼 서비스 + +
+ +## ✨ OUR TEAM + +| 프로필사진 | 프로필사진 | 프로필사진 | 프로필사진 | +| :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | +|
아름
|
은빈
|
정우
|
도윤
| +| [@Arooming](https://github.com/Arooming) | [@eunbeann](https://github.com/eunbeann) | [@jungwoo3490](https://github.com/jungwoo3490) | [@binllionaire](https://github.com/binllionaire) | + + +
+ +

🛠 기술스택

+ +
+ +| 역할 | 종류 | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Library | ![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=React&logoColor=black) | +| Programming Language | ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=TypeScript&logoColor=white) | +| Styling | ![Emotion](https://img.shields.io/badge/Emotion-000000?style=for-the-badge&logo=emotion&logoColor=white) | +| Data Fetching | ![React Query](https://img.shields.io/badge/react--query-FF4154?style=for-the-badge&logo=react-query&logoColor=white) | +| State Management | ![State Management](https://img.shields.io/badge/recoil-007af4?style=for-the-badge&logo=Recoil&logoColor=white) | +| Formatting | ![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white) ![Prettier](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E) ![StyleLint](https://img.shields.io/badge/stylelint-E0EFEF?style=for-the-badge&logo=stylelint&logoColor=000) | +| Package Manager | ![Yarn](https://img.shields.io/badge/Yarn-2C8EBB?style=for-the-badge&logo=yarn&logoColor=white) | +| Version Control | ![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white) | +| Deployment | ![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white) | + +
+ +
+ +

💡 주요 라이브러리

+ +``` + "@emotion/react": "^11.11.3", + "@emotion/styled": "^11.11.0", + "axios": "^1.6.5", + "postcss": "^8.4.33", + "react-query": "^3.39.3", + "react-router-dom": "^6.21.1", + "vite-plugin-svgr": "^4.2.0" +``` + +
+ +

📄 컨벤션 및 브랜치 전략

+

🔽💌 큐비들 공간 💌🔽

+ + +
+ +## 💻 Commit 컨벤션 + +- 기본적인것 (feat, fix, chore, ..) 위주로만 지키기! + +| 제목 | 내용 | +| ----------- | -------------------------------------------------------------------------------- | +| init | 브랜치 첫 커밋 | +| feat | 새로운 기능을 추가할 경우 | +| style | 기능에 영향을 주지 않는 커밋, 코드 순서, css 등의 포맷에 관한 커밋 | +| fix | 버그를 고친 경우 | +| refactor | 코드 리팩토링에 대한 커밋 | +| docs | 문서를 수정한 경우, 파일 삭제, 파일명 수정 등 | +| chore | 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우, 주석 추가, 자잘한 문서 수정 | +| code review | 코드 리뷰 반영 | + +
+ +## 🎋 브랜치 전략 +- **`feature/페이지명`** + - feature/SelectPage (파스칼) +- **`페이지명/#이슈번호-기능설명`** + - SelectPage/#3-select-custom (-로 연결) + +- 페이지명/이슈번호-기능설명 브랜치 ⇒ feature/페이지명으로 머지 +- feature/페이지명 완료 되면 ⇒ develop으로 머지 +- 중간 중간 develop ⇒ main 머지 + +
+ +## 💒 브랜치 운영 +- **main**: 우리가 개발 최종시에 Merge를 하는 곳 ❗️ +- **develop** : 개발할때 Merge +- **hotfix** : QA 시 수정사항 반영 +- **feature**: 기능을 개발하면서 각자가 사용할 브랜치 +- **test**: 개인 연습 브랜치 + +
+ +

📁 폴더 구조

+ +- 지역성의 원칙을 고려한 폴더구조 +- 한글 네이밍 가능 + +``` +├── public 🗂 썸네일 이미지, 로고 이미지 저장 +├── .eslintrc.cjs ✨ 린트 설정 +├── .prettierrc.cjs ✨ 프리티어 설정 +├── package.json 📦 설치된 패키지를 관리하는 파일 +└── src + ├── App.tsx ✡️ 앱의 라우팅과 글로벌 스타일 지정 + │ + ├── main.tsx + │ + ├── Router.tsx ✡️ 라우터 설정 + │ + ├── assets + │ ├── icon 🖼 이미지 파일들 저장 + │ ├── └── svgs 🌁 svg 파일들 저장 + │ + ├── components 🗂 공통 컴포넌트들 저장 + │ └── Modal.tsx + │ + ├── Login 🗂 각 기능 별 폴더 생성 + │ ├── pages 🗂 라우팅 시 보여질 페이지 컴포넌트 저장 + │ │ └── LoginPage.tsx + │ ├── components 🗂 해당 기능을 구현하는데 필요한 컴포넌트 저장 + │ │ ├── LoginFooter.tsx + │ │ ├── LoginCallback.tsx + │ │ └── LoginHome.tsx + │ │ + │ └── constants 🗂 상수 파일 저장 + │ + ├── styles 🗂 전역 스타일 관련 파일들 저장 + │ ├── GlobalStyle.ts + │ └── theme.ts + │ + ├── utils 🗂 util 함수 관련 파일들 저장 + │ + ├── libs 🗂 라이브러리리 관련 파일 저장 + │ ├── hooks 🗂 커스텀 훅 저장 + │ ├── api.ts + │ +``` + +
From 281dc10ad3209af908669e92fb7c871c24a3f64f Mon Sep 17 00:00:00 2001 From: seoAreum <80264647+Arooming@users.noreply.github.com> Date: Wed, 10 Jan 2024 12:37:01 +0900 Subject: [PATCH 2/4] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 87c28b8b..4466e4c2 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,11 @@
## 💡서비스 소개 -함께 꾸미며 ✨최애✨에게 진심을 전하는 롤링페이퍼 서비스 +다 함께 마음을 전해요. 최애를 위한 우리들의 롤링페이퍼, 레큐 + +최애만을 위한 레큐북을 만들고 링크로 전달해요. +각자의 마음을 담아 레큐노트를 작성해요. +다 함께 레큐북을 꾸며요.
From 1d163419cd38e485d99199f3c8f5a4770cf200d3 Mon Sep 17 00:00:00 2001 From: seoAreum <80264647+Arooming@users.noreply.github.com> Date: Wed, 10 Jan 2024 12:37:21 +0900 Subject: [PATCH 3/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4466e4c2..6884b0df 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ ## 💡서비스 소개 다 함께 마음을 전해요. 최애를 위한 우리들의 롤링페이퍼, 레큐 -최애만을 위한 레큐북을 만들고 링크로 전달해요. -각자의 마음을 담아 레큐노트를 작성해요. -다 함께 레큐북을 꾸며요. +- 최애만을 위한 레큐북을 만들고 링크로 전달해요. +- 각자의 마음을 담아 레큐노트를 작성해요. +- 다 함께 레큐북을 꾸며요.
From f9d8fd4fc916d42280f89b76654656c51322aa78 Mon Sep 17 00:00:00 2001 From: Eunbeann <65286685+eunbeann@users.noreply.github.com> Date: Wed, 10 Jan 2024 12:41:08 +0900 Subject: [PATCH 4/4] docs: update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6884b0df..85102415 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ | 프로필사진 | 프로필사진 | 프로필사진 | 프로필사진 | | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | -|
아름
|
은빈
|
정우
|
도윤
| -| [@Arooming](https://github.com/Arooming) | [@eunbeann](https://github.com/eunbeann) | [@jungwoo3490](https://github.com/jungwoo3490) | [@binllionaire](https://github.com/binllionaire) | +|
[짱리드]아름
|
은빈
|
정우
|
도윤
| +| [@Arooming](https://github.com/Arooming) | [@eunbeann](https://github.com/eunbeann/300x300) | [@jungwoo3490](https://github.com/jungwoo3490) | [@binllionaire](https://github.com/binllionaire) |