From 831f726a393dd985a875c83e76ce28edd371f803 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EC=9E=84=EB=B3=91=EC=9A=B1?= <103362820+wookki@users.noreply.github.com> Date: Fri, 19 Jan 2024 01:24:15 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20READ.ME=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 50 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6f7b35fb..dbc9157c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # ๐Ÿš— ์•ˆ์ „ํ•œ ์„ธ์ฐจ์šฉํ’ˆ ์ •๋ณด ์ œ๊ณต ํ”Œ๋žซํผ -- ๋ฐฐํฌ URL: https://f1-wash-pedia-fe.vercel.app -- ์Šคํ† ๋ฆฌ๋ถ URL: https://www.chromatic.com/library?appId=659a0cf1b613430cc09b3672 -- ํ”ผ๊ทธ๋งˆ URL: https://www.figma.com/file/B4wGiQ4M4k3mtcSyyK0ATf/washpedia?type=design&node-id=241-4547&mode=design&t=IuuBM2gGXeTFVTIW-0 +## ๐Ÿ”— ํ”„๋กœ์ ํŠธ ๋งํฌ +- [๋ฐฐํฌ URL](https://f1-wash-pedia-fe.vercel.app) +- [์Šคํ† ๋ฆฌ๋ถ URL](https://www.chromatic.com/library?appId=659a0cf1b613430cc09b3672) +- [ํ”ผ๊ทธ๋งˆ URL](https://www.figma.com/file/B4wGiQ4M4k3mtcSyyK0ATf/washpedia?type=design&node-id=241-4547&mode=design&t=IuuBM2gGXeTFVTIW-0) +- [๋…ธ์…˜ URL](https://www.notion.so/Wash-pedia-0d4a31ff248349b3a3ea202e048303d5)
@@ -17,8 +19,10 @@
## ๐Ÿ•น๏ธ ๊ธฐ์ˆ ์  ์„ฑ์ทจ + - ๋ฐฑ์—”๋“œ ํŒ€๊ณผ ๋น„๋™๊ธฐ์  ์†Œํ†ต ๋ฐ ํ˜‘์—… ๊ฒฝํ—˜ - ๊ธฐํš๋ถ€ํ„ฐ ๋””์ž์ธ๊นŒ์ง€ ์ฐธ์—ฌํ•œ ๊ฒฝํ—˜ +- storybook์„ ์ด์šฉํ•œ ์‹œ๊ฐ์  ํšŒ๊ท€ ํ…Œ์ŠคํŠธ ๋ฐ vitest, msw๋ฅผ ์ด์šฉํ•œ ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์„ฑ
@@ -77,3 +81,46 @@ **๊ทธ ์™ธ**
![Eslint](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white) +
+ +## ๐Ÿ‘ ์„ฑ๋Šฅ ์ตœ์ ํ™” +- ์›น ํฐํŠธ ๋‹ค์šด๋กœ๋“œ ์‹œ๊ฐ„์„ ์ค„์ด๊ธฐ ์œ„ํ•ด woff2 ํ™•์žฅ์ž ์ถ”๊ฐ€ ๋ฐ 3์ดˆ ์ด์ƒ ํฐํŠธ๊ฐ€ ๋‹ค์šด๋กœ๋“œ ๋˜์ง€ ๋ชปํ•œ ๊ฒฝ์šฐ, ๊ธฐ์กด ํฐํŠธ๋ฅผ ์‚ฌ์šฉํ•˜๋„๋ก fallback ์„ค์ • +- ํ•„์š”ํ•œ ์‹œ์ ์— ์ด๋ฏธ์ง€๋ฅผ ๋ถˆ๋Ÿฌ์˜ค๋„๋ก lazy loading์„ ์ ์šฉ ๋ฐ layout shift๋ฅผ ๋ฐฉ์ง€ํ•˜๊ธฐ ์œ„ํ•œ Next.js image ํƒœ๊ทธ ์ ์šฉ +- ๋ Œ๋”๋ง ์‹œ ๋ถˆํ•„์š”ํ•œ ์—ฐ์‚ฐ์„ ์ค„์ด๊ธฐ ์œ„ํ•ด useCallback, useMemo ์‚ฌ์šฉ +- dynamic import๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๋นŒ๋“œ ํƒ€์ž„์ด ์•„๋‹Œ ๋Ÿฐํƒ€์ž„์—์„œ ์ปดํฌ๋„ŒํŠธ๋ฅผ ๋žœ๋”๋ง ํ•˜๋„๋ก ์ฝ”๋“œ ์Šคํ”Œ๋ฆฌํŒ… ์ ์šฉ +- react-hook-form์„ ์‚ฌ์šฉํ•˜์—ฌ ๋ถˆํ•„์š”ํ•œ ๋ฆฌ๋žœ๋”๋ง ๋ฐฉ์ง€ ๋ฐ ๋งˆ์šดํŒ… ์†๋„ ์ฆ๊ฐ€ +- ๋ถˆํ•„์š”ํ•œ api ์š”์ฒญ์„ ๋ฐฉ์ง€ํ•˜๊ธฐ ์œ„ํ•ด tanstack-query๋ฅผ ํ™œ์šฉํ•œ ๋ฐ์ดํ„ฐ ์บ์‹ฑ + +
+ +## โœˆ๏ธ ์ง„ํ–‰ ์‚ฌํ•ญ +- ์ดˆ๊ธฐ ํ™˜๊ฒฝ ์„ค์ • + - ๋ฆฐํŠธ ๋ฐ ์Šคํƒ€์ผ ๋ฆฐํŠธ ์„ค์ • + - tanstack-query ๋ณด์ผ๋Ÿฌ ํ”Œ๋ ˆ์ดํŠธ ์ œ์ž‘ + - redux-toolkit ๋ณด์ผ๋Ÿฌ ํ”Œ๋ ˆ์ดํŠธ ์ œ์ž‘ + - storybook ๋ณด์ผ๋Ÿฌ ํ”Œ๋ ˆ์ดํŠธ ์ œ์ž‘ + - vitest ๋ณด์ผ๋Ÿฌ ํ”Œ๋ ˆ์ดํŠธ ์ œ์ž‘ + - msw ๋ณด์ผ๋Ÿฌ ํ”Œ๋ ˆ์ดํŠธ ์ œ์ž‘ + - pretandard ํฐํŠธ ์„ค์ • + - ์ปฌ๋Ÿฌ ํŒ”๋ ˆํŠธ ์ œ์ž‘ + - ci / cd workflow ์ž‘์„ฑ + - vercel ๋ฐฐํฌ + +- 20๊ฐœ ๊ณตํ†ต ์ปดํฌ๋„ŒํŠธ ์ œ์ž‘ + - [์Šคํ† ๋ฆฌ๋ถ URL](https://www.chromatic.com/library?appId=659a0cf1b613430cc09b3672) <- ์ฐธ๊ณ ํ•ด์ฃผ์„ธ์š”! + +- ํŽ˜์ด์ง€ <- ๋ชจ๋ฐ”์ผ ํ™˜๊ฒฝ์—์„œ ๋ด์ฃผ์„ธ์š”! + - ๋ฉ”์ธ ํŽ˜์ด์ง€ UI ์ œ์ž‘ [ํ™ˆ ํŽ˜์ด์ง€](https://f1-wash-pedia-fe.vercel.app) + - ํšŒ์› ๊ฐ€์ž… ํŽ˜์ด์ง€ UI ๋ฐ ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ž‘์„ฑ [ํšŒ์›๊ฐ€์ž… ํŽ˜์ด์ง€](https://f1-wash-pedia-fe.vercel.app/signup) + - ๋กœ๊ทธ์ธ ํŽ˜์ด์ง€ UI ์ œ์ž‘ [๋กœ๊ทธ์ธ ํŽ˜์ด์ง€](https://f1-wash-pedia-fe.vercel.app/login) + +## ๐Ÿ–๏ธ ์งˆ๋ฌธ ์‚ฌํ•ญ +1. ์Šคํ† ๋ฆฌ๋ถ์„ ์‚ฌ์šฉํ•˜๊ณ  ์žˆ์ง€๋งŒ ๋‹จ์ˆœํžˆ props๋งŒ ๋ฐ”๊ฟ”๊ฐ€๋ฉฐ ๋ณ€๊ฒฝ๋œ UI๋งŒ ๋ณผ ์ˆ˜ ์žˆ๋„๋ก ํ…Œ์ŠคํŒ…์„ ํ•˜๊ณ  ์žˆ๋Š”๋ฐ ํ˜„์—…์—์„  ์–ด๋–ค ์‹์œผ๋กœ ์Šคํ† ๋ฆฌ๋ถ์„ ์‚ฌ์šฉํ•˜๋‚˜์š”? +2. next.js์—์„œ private router ๊ตฌํ˜„ํ•˜๋ ค๋ฉด HOC๋ฅผ ์ด์šฉํ•˜์—ฌ ์ปดํฌ๋„ŒํŠธ๋ฅผ ๊ฐ์‹ธ ์œ ์ €๊ฐ€ ๊ฐ€์ง„ token์„ ์ด์šฉํ•˜์—ฌ ์œ ํšจํ•œ ํšŒ์›์ธ์ง€ ํŒ๋‹จํ•˜๋Š” ๋กœ์ง ์ผ๋ฐ˜์ ์ธ๊ฐ€์š”? ๊ทธ๊ฒŒ ์•„๋‹ˆ๋ผ๋ฉด +์–ด๋–ค ์‹์œผ๋กœ ๊ตฌํ˜„ํ•˜๋Š” ๊ฒŒ ์ข‹์„๊นŒ์š”? +3. swiper.js๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์บ๋Ÿฌ์…€์„ ์ œ์ž‘ํ–ˆ๋Š”๋ฐ ์ดˆ๊ธฐ ๋žœ๋”๋ง ์‹œ layout shift๊ฐ€ ๋ฐœ์ƒํ•˜๋Š” ๋ฌธ์ œ์ ์ด ์žˆ์–ด์š”. ์ด ๋ฌธ์ œ์ ์„ ํ•ด๊ฒฐํ•  ์ˆ˜ ์žˆ๋Š” ์ข‹์€ ๋ฐฉ๋ฒ•์ด ์žˆ์„๊นŒ์š”? + + + + +