-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/Team-Lecue/Lecue-Client int…
…o develop
- Loading branch information
Showing
1 changed file
with
152 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,152 @@ | ||
| 아루밍 비니 쩡우 도리 큐비들 사랑해~❤️ | ||
| <div align="center"> | ||
| <h1> 💌 Lecue 💌 </h1> | ||
|
|
||
| <img alt="로고 대문 이미지" src="https://private-user-images.githubusercontent.com/67463603/294701719-77faaad4-1dc0-49ff-a19c-71f07e52b9ac.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MDQ4NTc4MjEsIm5iZiI6MTcwNDg1NzUyMSwicGF0aCI6Ii82NzQ2MzYwMy8yOTQ3MDE3MTktNzdmYWFhZDQtMWRjMC00OWZmLWExOWMtNzFmMDdlNTJiOWFjLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDAxMTAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwMTEwVDAzMzIwMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTBkOTYxY2U3Y2E1Mjg5YzVjOTg0MTNkODA2ZWY3ZTI3N2MzN2I2NmUxNjkwNDA1OGVjNzljMGE3NzAwMjg5YjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.rFdpID458vCvpq31f0EFZxZ1bT8OSHCf_XAIDs5SH-s"> | ||
| </div> | ||
|
|
||
| <br/> | ||
|
|
||
| ## 💡서비스 소개 | ||
| 다 함께 마음을 전해요. 최애를 위한 우리들의 롤링페이퍼, 레큐 | ||
|
|
||
| - 최애만을 위한 레큐북을 만들고 링크로 전달해요. | ||
| - 각자의 마음을 담아 레큐노트를 작성해요. | ||
| - 다 함께 레큐북을 꾸며요. | ||
|
|
||
| <br/> | ||
|
|
||
| ## ✨ OUR TEAM | ||
|
|
||
| | <img src="https://avatars.githubusercontent.com/u/80264647?v=4" width="200" height="200" alt="프로필사진"> | <img src="https://avatars.githubusercontent.com/u/65286685?v=4" width="200" height="200" alt="프로필사진"> | <img src="https://avatars.githubusercontent.com/u/60962533?v=4" width="200" height="200" alt="프로필사진"> | <img src="https://velog.velcdn.com/images/aroo_ming/post/a9437eb2-9104-4c8b-912f-1a8b6eaf6f9d/image.jpeg" width="200" height="200" alt="프로필사진"> | | ||
| | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | | ||
| | <div align = "center"><b>[짱리드]아름</b></div> | <div align = "center"><b>은빈</b></div> | <div align = "center"><b>정우</b></div> | <div align = "center"><b>도윤</b></div> | | ||
| | [@Arooming](https://github.com/Arooming) | [@eunbeann](https://github.com/eunbeann/300x300) | [@jungwoo3490](https://github.com/jungwoo3490) | [@binllionaire](https://github.com/binllionaire) | | ||
|
|
||
|
|
||
| <br/> | ||
|
|
||
| <h2> 🛠 기술스택 </h2> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| | 역할 | 종류 | | ||
| | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Library |  | | ||
| | Programming Language |  | | ||
| | Styling |  | | ||
| | Data Fetching |  | | ||
| | State Management |  | | ||
| | Formatting |    | | ||
| | Package Manager |  | | ||
| | Version Control |   | | ||
| | Deployment |  | | ||
|
|
||
| </div> | ||
|
|
||
| <br/> | ||
|
|
||
| <h2> 💡 주요 라이브러리 </h2> | ||
|
|
||
| ``` | ||
| "@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" | ||
| ``` | ||
|
|
||
| <br/> | ||
|
|
||
| <h2> 📄 컨벤션 및 브랜치 전략 </h2> | ||
| <h3>🔽💌 큐비들 공간 💌🔽</h3> | ||
| <a href="https://rileybyeon.notion.site/88b85dd3178242b9a78458970a6aa5d7?pvs=4"><img src="https://img.shields.io/badge/Notion 링크-white?style=for-the-badge&logo=Notion&logoColor=000000"/></a> | ||
|
|
||
| <br/> | ||
|
|
||
| ## 💻 Commit 컨벤션 | ||
|
|
||
| - 기본적인것 (feat, fix, chore, ..) 위주로만 지키기! | ||
|
|
||
| | 제목 | 내용 | | ||
| | ----------- | -------------------------------------------------------------------------------- | | ||
| | init | 브랜치 첫 커밋 | | ||
| | feat | 새로운 기능을 추가할 경우 | | ||
| | style | 기능에 영향을 주지 않는 커밋, 코드 순서, css 등의 포맷에 관한 커밋 | | ||
| | fix | 버그를 고친 경우 | | ||
| | refactor | 코드 리팩토링에 대한 커밋 | | ||
| | docs | 문서를 수정한 경우, 파일 삭제, 파일명 수정 등 | | ||
| | chore | 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우, 주석 추가, 자잘한 문서 수정 | | ||
| | code review | 코드 리뷰 반영 | | ||
|
|
||
| <br/> | ||
|
|
||
| ## 🎋 브랜치 전략 | ||
| - **`feature/페이지명`** | ||
| - feature/SelectPage (파스칼) | ||
| - **`페이지명/#이슈번호-기능설명`** | ||
| - SelectPage/#3-select-custom (-로 연결) | ||
|
|
||
| - 페이지명/이슈번호-기능설명 브랜치 ⇒ feature/페이지명으로 머지 | ||
| - feature/페이지명 완료 되면 ⇒ develop으로 머지 | ||
| - 중간 중간 develop ⇒ main 머지 | ||
|
|
||
| <br/> | ||
|
|
||
| ## 💒 브랜치 운영 | ||
| - **main**: 우리가 개발 최종시에 Merge를 하는 곳 ❗️ | ||
| - **develop** : 개발할때 Merge | ||
| - **hotfix** : QA 시 수정사항 반영 | ||
| - **feature**: 기능을 개발하면서 각자가 사용할 브랜치 | ||
| - **test**: 개인 연습 브랜치 | ||
|
|
||
| <br/> | ||
|
|
||
| <h2> 📁 폴더 구조 </h2> | ||
|
|
||
| - 지역성의 원칙을 고려한 폴더구조 | ||
| - 한글 네이밍 가능 | ||
|
|
||
| ``` | ||
| ├── 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 | ||
| │ | ||
| ``` | ||
|
|
||
| <br/> |