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๊ฐ ๋ฐ์ํ๋ ๋ฌธ์ ์ ์ด ์์ด์. ์ด ๋ฌธ์ ์ ์ ํด๊ฒฐํ ์ ์๋ ์ข์ ๋ฐฉ๋ฒ์ด ์์๊น์?
+
+
+
+
+