๐ฑ[PHOBUM] ReadMe ์์ฑ
๐ฑ ํฌ๋ฒ (Phobum) - ๋น์ ๋ง์ ํฌํ ์นด๋ ์ ์ ์๋น์ค
๋๋ง์ ํน๋ณํ ํฌํ ์นด๋๋ฅผ ๋ง๋ค๊ณ ๊ณต์ ํ๋ ์น ์ ํ๋ฆฌ์ผ์ด์ ์ ๋๋ค.
โจ ์ฃผ์ ๊ธฐ๋ฅ
- ๐ผ๏ธ WebP ์ต์ ํ๋ฅผ ํตํ ๊ณ ํ์ง ํฌํ ์นด๋ ์ ์
- ๐ ํ๋ฆฌ์ฆ ํจ๊ณผ๊ฐ ์๋ 3D ์ธํฐ๋ํฐ๋ธ ์นด๋
- ๐ ์นด์นด์ค ์์ ๋ก๊ทธ์ธ ๋ฐ ์ผ๋ฐ ๋ก๊ทธ์ธ ์ง์
- ๐ค ์ฌ์ฉ์ ํ๋กํ ๊ด๋ฆฌ
- ๐ฑ ๋ชจ๋ฐ์ผ/๋ฐ์คํฌํฑ ๋ฐ์ํ ๋์์ธ
- ๐ซ ๋ถ๋๋ฌ์ด ์ ๋๋ฉ์ด์ ๊ณผ ์ ํ ํจ๊ณผ
๐ ๏ธ ๊ธฐ์ ์คํ
- ํ๋ ์์ํฌ:
React
- ์คํ์ผ๋ง:
Styled Components
- ์ํ๊ด๋ฆฌ:
Zustand
๐ป - API ํต์ :
Axios
- ํ์
์์ ์ฑ:
TypeScript
- ์ธ์ฆ: JWT (๋ฆฌํ๋ ์ ํ ํฐ)
- ์ด๋ฏธ์ง ์ฒ๋ฆฌ: WebP ๋ณํ
๐ ์์ํ๊ธฐ
-
์ ์ฅ์ ํด๋ก :
git clone [์ ์ฅ์-URL]
-
์์กด์ฑ ์ค์น:
yarn install
-
ํ๊ฒฝ๋ณ์ ์ค์ :
REACT_APP_API_BASE_URL=๋ฐฑ์๋_API_์ฃผ์
-
๊ฐ๋ฐ ์๋ฒ ์คํ:
yarn start
๐ ํ๋ก์ ํธ ๊ตฌ์กฐ
src/
โโโ api/ # API ํต์ ๊ด๋ จ
โโโ assets/ # ์ ์ ์์
โโโ components/ # ์ฌ์ฌ์ฉ ์ปดํฌ๋ํธ
โโโ constants/ # ์ ์ญ ์์
โโโ pages/ # ํ์ด์ง ์ปดํฌ๋ํธ
โโโ provider/ # Context ์ ๊ณต์
โโโ store/ # ์ ์ญ ์ํ ๊ด๋ฆฌ
โโโ styles/ # ์ ์ญ ์คํ์ผ
โโโ types/ # ํ์
์ ์
โโโ utils/ # ์ ํธ๋ฆฌํฐ ํจ์
๐ฑ ์ฌ์ฉ ๊ฐ๋ฅํ ์คํฌ๋ฆฝํธ
yarn start
- ๊ฐ๋ฐ ๋ชจ๋ ์คํ
yarn build
- ํ๋ก๋์
์ฉ ๋น๋
yarn test
- ํ
์คํธ ์คํ
yarn eject
- CRA ์ค์ ์ถ์ถ
๐จ ์์ธ ๊ธฐ๋ฅ
ํฌํ ์นด๋ ์ ์
- ์ด๋ฏธ์ง ์ ๋ก๋ ๋ฐ ๋ฏธ๋ฆฌ๋ณด๊ธฐ
- WebP ํฌ๋งท ์ต์ ํ
- ์ ๋ชฉ๊ณผ ์ค๋ช ์ ๋ ฅ
- 3D ์ธํฐ๋ํฐ๋ธ ํจ๊ณผ
์ธ์ฆ ์์คํ
- ์นด์นด์ค OAuth ์ฐ๋
- ์์ฒด ๋ก๊ทธ์ธ ์์คํ
- ํ ํฐ ๋ณด์ ๊ด๋ฆฌ
- ๋ณดํธ๋ ๋ผ์ฐํธ
์ฌ์ฉ์ ๊ฒฝํ
- ๋ถ๋๋ฌ์ด ์ ํ ํจ๊ณผ
- ๋ฐ์ํ ๋์์ธ
- ์ค๋ฅ ์ฒ๋ฆฌ
- ๋ก๋ฉ ์ํ
๐ ์ ์๊ถ ๋ฐ ์ฌ์ฉ๊ถ
์ด ํ๋ก์ ํธ๋ ๊ฐ์ธ ํ๋ก์ ํธ์ด๋ฉฐ ๋ชจ๋ ๊ถ๋ฆฌ๋ ์ ์์์๊ฒ ์์ต๋๋ค.
- ๐ ์ฌ์ฉ ์ ํ
- ์์ ์ ์ฌ์ฉ ๋ถ๊ฐ
- ๋ฌด๋จ ๋ณต์ ๋ฐ ๋ฐฐํฌ ๊ธ์ง
- ์์ค ์ฝ๋ ๋ฌด๋จ ์ฌ์ฉ ๊ธ์ง
- โ
๊ฐ๋ฅํ ๊ฒ
- ๊ฐ์ธ์ ์ธ ํ์ต ๋ชฉ์ ์ผ๋ก ์ฝ๋ ์ฐธ๊ณ
- ๋น์์ ์ ๋ชฉ์ ์ ํ ์คํธ
- โ ๏ธ ์ฃผ์์ฌํญ
- ํ๋ก์ ํธ ๋ด ์ฌ์ฉ๋ ์ด๋ฏธ์ง, ๋์์ธ ๋ฑ์ ์์ ์ ๋ณ๋์ ๋ผ์ด์ ์ค๋ฅผ ๊ฐ์ง ์ ์์
- ํ๋ก์ ํธ ์ฌ์ฉ ์ ์ถ์ฒ ํ๊ธฐ ํ์
ยฉ 2024 Phobum. All Rights Reserved.
๋๊ธ๋จ๊ธฐ๊ธฐ