diff --git a/README.md b/README.md index ac98559c..012494c0 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,185 @@ -# PNPM ์‚ฌ์šฉ +# ๐Ÿฑ COCOS +๋ฐ˜๋ ค๋™๋ฌผ ์ฆ์ƒ์„ ๊ฒช๋Š” ๋ฐ˜๋ ค์ธ๋“ค์ด ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ํ†ตํ•ด ๊ณ ๋ฏผ์„ ๊ณต์œ ํ•˜๊ณ  ๋ณ‘์› ์ •๋ณด๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋Š” ์„œ๋น„์Šค! -์šฐ๋ฆฐ ํŒจํ‚ค์ง€๋งค๋‹ˆ์ €๋กœ pnpm ์‚ฌ์šฉํ•˜๋‹ˆ๊นŒ ๊ผญ pnpm -v ํ™•์ธํ•ด์„œ ์ž˜ ์„ค์น˜๋˜์–ด ์žˆ๋Š”์ง€ ํ™•์ธํ•˜๊ณ  -pnpm add, pnpm install, pnpm dev, pnpm build ์™€ ๊ฐ™์ด yarn ๋Œ€์‹  pnpm ์œผ๋กœ ์‚ฌ์šฉํ•ด!! -(pnpm -v ํ–ˆ์„ ๋•Œ corepack์„ ์„ค์น˜ํ• ๊ฑฐ๋ƒ๋Š” ์งˆ๋ฌธ์—๋Š” ๋ฌด์กฐ๊ฑด y ํ•ด์•ผํ•จ!!) +

๐Ÿถ COCOS Team

-## svgr ์‚ฌ์šฉ -> svg ํŒŒ์ผ์„ ์ปดํฌ๋„ŒํŠธ์ฒ˜๋Ÿผ ์‚ฌ์šฉํ•˜๊ธฐ + + + + + + + + + + + + + +
+ + ํ”„๋กœํ•„์‚ฌ์ง„ +
+ ๐ŸŽง๊ณต์ค€ํ˜ +
+
+ + ํ”„๋กœํ•„์‚ฌ์ง„ +
+ ๐ŸŒธ๊น€๋ฏผ์ • +
+
+ + ํ”„๋กœํ•„์‚ฌ์ง„ +
+ ๐Ÿถ์ด์˜ˆ๋ฆผ +
+
+ + ํ”„๋กœํ•„์‚ฌ์ง„ +
+ ๐Ÿพ์ด์œค์ง€ +
+
+ ๋งˆ์ดํŽ˜์ด์ง€ ๋ทฐ
+
+ ๊ฒ€์ƒ‰, ๊ฒŒ์‹œ๋ฌผ ๋ทฐ
+
+ ๋กœ๊ทธ์ธ, ์˜จ๋ณด๋”ฉ ๋ทฐ
+
+ ๋ฉ”์ธ, ์ปค๋ฎค๋‹ˆํ‹ฐ ๋ทฐ
+
-svg ํŒŒ์ผ์„ react component ์ฒ˜๋Ÿผ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด, .svg ํŒŒ์ผ์„ public > svgs ํด๋” ์•ˆ์— ๋„ฃ์€ ๋’ค, -pnpm svgr ๋ช…๋ น์–ด ์ž…๋ ฅํ•ด์„œ ์‚ฌ์šฉํ•˜๊ธฐ ! ๊ทธ๋Ÿฌ๋ฉด ์•Œ์•„์„œ src > asset > svg ํด๋” ์•ˆ์— ํ•„์š”ํ•œ ํŒŒ์ผ๋“ค์ด ์ƒ์„ฑ๋ ๊ฑฐ์•ผ! +
+

๐Ÿ›  ๊ธฐ์ˆ ์Šคํƒ

-## ์ „์—ญ ์Šคํƒ€์ผ ์„ธํŒ…ํ•˜๋Š” ์‚ฌ๋žŒ์€ ๋ฐ˜๋“œ์‹œ width 375px๊ณผ ์ค‘์•™ ์ •๋ ฌ๋„ ์‹ ๊ฒฝ ์จ์„œ ๋งŒ๋“ค์–ด๋‘๊ธฐ ! +
+ +| ์—ญํ•  | ์ข…๋ฅ˜ | ์„ ์ • ์ด์œ  +| -------------------- | ------------- | ------------------- | +| 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 | ![Vanila Extract](https://img.shields.io/badge/vanila--extract-FFEC6E?style=for-the-badge&logo=vala&logoColor=white) | ํƒ€์ž… ์•ˆ์ „์„ฑ๊ณผ ๋ชจ๋“ˆํ™”๋œ ์Šคํƒ€์ผ๋ง์„ ์ œ๊ณตํ•˜์—ฌ ์œ ์ง€๋ณด์ˆ˜์„ฑ์„ ๊ฐ•ํ™” +| Data Fetching | ![Tanstack-Query](https://img.shields.io/badge/reactquery-FF4154.svg?style=for-the-badge&logo=reactquery&logoColor=white) | ๋ฐ์ดํ„ฐ ํŒจ์นญ๊ณผ ์บ์‹ฑ์„ ํšจ์œจ์ ์œผ๋กœ ๊ด€๋ฆฌํ•˜๊ณ  ๊ฐ„ํŽธํ•˜๊ฒŒ ์„œ๋ฒ„ ์ƒํƒœ๋ฅผ ๋™๊ธฐํ™”ํ•˜๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉ +| State Management | ![Zustand](https://img.shields.io/badge/zustand-000000.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4&logoColor=white) | ๊ฐ„๊ฒฐํ•˜๊ณ  ์œ ์—ฐํ•œ ์ƒํƒœ ๊ด€๋ฆฌ๋กœ ์ง๊ด€์ ์ธ ๋กœ์ง ๊ตฌํ˜„์„ ์ง€์› +| Formatting | ![biome](https://img.shields.io/badge/biome-60A5FA?style=for-the-badge&logo=biome&logoColor=000) | ์ฝ”๋“œ ํฌ๋งทํŒ…๊ณผ ๋ฆฐํŒ…์„ ํ†ตํ•ฉ ๊ด€๋ฆฌํ•ด ์ผ๊ด€๋œ ์ฝ”๋“œ ์Šคํƒ€์ผ ์œ ์ง€ +| Package Manager | ![Pnpm](https://img.shields.io/badge/pnpm-F69220.svg?style=for-the-badge&logo=pnpm&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) |์‰ฌ์šด ๋ฐฐํฌ์™€ ๊ธ€๋กœ๋ฒŒ CDN์„ ํ†ตํ•ด ๋น ๋ฅด๊ณ  ์•ˆ์ •์ ์ธ ์‚ฌ์šฉ์ž ๊ฒฝํ—˜ ์ œ๊ณต + + + + + + + +
+ +
+ +

๐Ÿ“„ ์ปจ๋ฒค์…˜ ๋ฐ ๋ธŒ๋žœ์น˜ ์ „๋žต (Git, Branch)

+

Git Branch

+ +``` +- main (๋ฐฐํฌ์šฉ) +- develop (๊ฐœ๋ฐœ์šฉ) +- feat/#issue/๊ธฐ๋Šฅ๋ช… (์ž‘์—…์šฉ) +``` + +

Commit Convention

+Commit Message ๐Ÿ‘‰ ๊ธฐ๋Šฅ ํ‚ค์›Œ๋“œ: ์ปค๋ฐ‹ ๋‚ด์šฉ
+ +``` +feat : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ +fix : ๋ฒ„๊ทธ ์ˆ˜์ • +chore : ๋นŒ๋“œ ์—…๋ฌด, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ, dependencies ์„ค์ • +docs : ๋ฌธ์„œ ์ˆ˜์ • - ex) [README.md](http://readme.md/) +design : ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ - ex) CSS +style : ๊ธฐ๋Šฅ ์ˆ˜์ • ์—†๋Š” ์ฝ”๋“œ ์Šคํƒ€์ผ ๋ณ€๊ฒฝ +refactor : ์ฝ”๋“œ ๋ฆฌํŒฉํ„ฐ๋ง +test : ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€ +ci : ci ์„ค์ • ํŒŒ์ผ ์ˆ˜์ • +perf : ์„ฑ๋Šฅ ๊ฐœ์„  +rename : ํŒŒ์ผ ํ˜น์€ ํด๋”๋ช… ๋ณ€๊ฒฝ +``` + +

Coding Convention

+COCOS Web์˜ ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜ + +

PR & Issue Template

+์ด์Šˆ ๋ฐ pr ํ…œํ”Œ๋ฆฟ์€ ์‹ค์ œ๋กœ ์ด์Šˆ์™€ PR์ด ์˜ฌ๋ผ์˜ค๋Š” ํ…œํ”Œ๋ฆฟ ํ™•์ธ! +
+ +

๐Ÿ“ท ๊ตฌํ˜„ ์Šคํฌ๋ฆฐ์ƒท

+to be continue... +
+ +

๐Ÿ“ ํด๋” ๊ตฌ์กฐ

+ +``` +๐Ÿ“ฆ public +๐Ÿ“ฆ src + โ”ฃ ๐Ÿ“‚asset + โ”ƒ โ”ฃ ๐Ÿ“‚svg + โ”ƒ โ”— ๐Ÿ“‚image + โ”ฃ ๐Ÿ“‚api + โ”ƒ โ”ฃ ๐Ÿ“‚domain + โ”ƒ โ”ฃ ๐Ÿ“‚kakaologin + โ”ƒ โ”— ๐Ÿ“œindex.ts + โ”ฃ ๐Ÿ“‚common + โ”ƒ โ”ฃ ๐Ÿ“‚component + โ”ƒ โ”ฃ ๐Ÿ“‚util + โ”ƒ โ”ฃ ๐Ÿ“‚hook + โ”ƒ โ”— ๐Ÿ“‚service + โ”ฃ ๐Ÿ“‚shared + โ”ƒ โ”ฃ ๐Ÿ“‚component + โ”ƒ โ”ฃ ๐Ÿ“‚util + โ”ƒ โ”ฃ ๐Ÿ“‚hook + โ”ƒ โ”ฃ ๐Ÿ“‚storage + โ”ƒ โ”ฃ ๐Ÿ“‚store + โ”ƒ โ”ฃ ๐Ÿ“‚constant + โ”ƒ โ”— ๐Ÿ“‚style + โ”ฃ ๐Ÿ“‚page + โ”ƒ โ”ฃ ๐Ÿ“‚main + โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚user + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚component + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚constant + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚type + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚hook + โ”ƒ โ”ƒ โ”ƒ โ”— ๐Ÿ“‚util + โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚shared + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚component + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚constant + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚hook + โ”ƒ โ”ƒ โ”ƒ โ”— ๐Ÿ“‚util + โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚index + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚component + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚constant + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚type + โ”ƒ โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“‚hook + โ”ƒ โ”ƒ โ”ƒ โ”— ๐Ÿ“‚util + โ”ƒ โ”ƒ โ”ฃ ๐Ÿ“œMain.tsx + โ”ƒ โ”ƒ โ”— ๐Ÿ“œMain.styled.ts + โ”ƒ โ”ฃ ๐Ÿ“‚admin + โ”ƒ โ”— ๐Ÿ“‚mypage + โ”ฃ ๐Ÿ“‚style + โ”ƒ โ”ฃ ๐Ÿ“œGlobalStyles.ts + โ”ƒ โ”— ๐Ÿ“œtheme.ts + โ”ฃ ๐Ÿ“‚type + โ”ƒ โ”— ๐Ÿ“œglobal.d.ts + โ”ฃ ๐Ÿ“‚route + โ”ƒ โ”— ๐Ÿ“œRouter.tsx + โ”ฃ ๐Ÿ“œApp.tsx + โ”ฃ ๐Ÿ“œmain.tsx + โ”ฃ ๐Ÿ“œeslint.config.js + โ”ฃ ๐Ÿ“œ.gitignore + โ”ฃ ๐Ÿ“œ.prettierrc.json + โ”ฃ ๐Ÿ“œ.stylelintrc.json + โ”ฃ ๐Ÿ“œREADME.md + โ”ฃ ๐Ÿ“œpackage.json + โ”ฃ ๐Ÿ“œtsconfig.json + โ”— ๐Ÿ“œyarn.lock + +```