diff --git a/README.md b/README.md index 11bc5da3..5cba2309 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,27 @@ -# VECO Frontend - +# ๐Ÿฏ VECO VECO๋Š” **AI๋ฅผ ํ™œ์šฉํ•ด ๋ถ„์‚ฐ๋œ ์ •๋ณด๋ฅผ ํ•œ๊ณณ์— ๋ชจ์œผ๊ณ , ๋ชฉํ‘œ๋ฅผ ๋ช…ํ™•ํžˆ ์ถ”์ ํ•˜๋ฉฐ ํ˜‘์—…์„ ํšจ์œจํ™”ํ•˜๋Š” ์‹œ์Šคํ…œ**์ž…๋‹ˆ๋‹ค. ์ด ์ €์žฅ์†Œ๋Š” VECO์˜ **ํ”„๋ก ํŠธ์—”๋“œ ๊ฐœ๋ฐœ์„ ๋‹ด๋‹นํ•˜๋Š” ๋ ˆํฌ์ง€ํ† ๋ฆฌ**์ž…๋‹ˆ๋‹ค. +
+
+image + + --- ## ๐Ÿ“ฆ ๊ธฐ์ˆ  ์Šคํƒ -- React -- TypeScript -- Vite -- Tailwind CSS -- ESLint (Flat Config) -- Prettier +| ์—ญํ•  | ์ข…๋ฅ˜ | +| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Library | ![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=React&logoColor=white) ![VITE](https://img.shields.io/badge/VITE-646CFF?style=for-the-badge&logo=Vite&logoColor=white) | +| Programming Language | ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6.svg?style=for-the-badge&logo=TypeScript&logoColor=white) | +| Styling | TailwindCSS Badge| +| Data Fetching | ![Axios](https://img.shields.io/badge/Axios-5A29E4?style=for-the-badge&logo=Axios&logoColor=white) TanStack Query Badge | +| Formatting | ![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white) ![Prettier](https://img.shields.io/badge/Prettier-F7B93E?style=for-the-badge&logo=prettier&logoColor=white) | +| Package Manager | ![Npm](https://img.shields.io/badge/npm%20-grey?style=for-the-badge&logo=npm) | +| 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) | +| State Management | Zustand Badge | +| Deploy | Vercel Badge | --- @@ -26,7 +35,6 @@ npm install npm run dev ``` ---- ## ๐Ÿ”ง ์ž‘์—… ์ „ ๊ณตํ†ต ์ ˆ์ฐจ: develop ๋ธŒ๋žœ์น˜ ์ตœ์‹ ํ™” @@ -38,6 +46,7 @@ git checkout develop git pull origin develop ``` + ## ๐Ÿ›  ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ ```bash @@ -45,6 +54,7 @@ git pull origin develop git checkout -b feature/#์ด์Šˆ๋ฒˆํ˜ธ-์Šคํฌ๋ฆฐID-์ž‘์—…๋ช… ``` + ## ๐Ÿš€ PR ์ „ ์ ๊ฒ€ ๋ฐ ๋ณ‘ํ•ฉ ```bash @@ -60,3 +70,28 @@ git merge develop # ์ถฉ๋Œ ํ•ด๊ฒฐ ํ›„ ์ปค๋ฐ‹ ``` + +--- + +## ๐Ÿ“ ์ปจ๋ฒค์…˜ + +- ๐ŸŒฟ [Commit Convention](https://pretty-tumbleweed-40b.notion.site/Github-Commit-Convention-2212d37cca1180f882f6c607935e07bb?source=copy_link) +- ๐Ÿชต [Branch Convention](https://pretty-tumbleweed-40b.notion.site/Github-Branch-Convention-2212d37cca1180b99416cae996470a9d?source=copy_link) +- ๐Ÿ“Œ [Issue Convention](https://pretty-tumbleweed-40b.notion.site/ISSUE-2212d37cca1180b5b904fc4ea5653f54?source=copy_link) +- โœ… [PR Convention](https://pretty-tumbleweed-40b.notion.site/PR-2212d37cca1180608135d6bccffeaed6?source=copy_link) + +--- + +## ๐Ÿ“– ์•„ํ‹ฐํด ๋ชจ์Œ +| ์ด๋ฆ„ | ์•„ํ‹ฐํด ์ œ๋ชฉ | +| ------ | ---------------------------------------------------------------------------------------------------------------------------------- | +| ๐Ÿ€ ๊น€์„ ํ™” | [๋ฐ๋ชจ๋ฐ์ด ํŠธ๋Ÿฌ๋ธ”์ŠˆํŒ…](https://velog.io/@sunhwaa/UMC-01) | +| ๐Ÿ’ ๋ฐ•์œ ๋ฏผ | [Onboarding & ํ† ํฐ ์ด์Šˆ ํ•ด๊ฒฐ๊ธฐ](https://velog.io/@waldls/VECO-9zb3jefr) | +| ๐Ÿ’Ž ๋ฐ•์ง„์ฃผ | [DOM ์—…๋ฐ์ดํŠธ์™€ ๋Œ“๊ธ€ ์Šคํฌ๋กค ํƒ€์ด๋ฐ ๋ฌธ์ œ ํ•ด๊ฒฐ๊ธฐ](https://icems0428.tistory.com/25) | +| ๐ŸŽ€ ์—ผ์ฃผ์› | [ํŠธ๋Ÿฌ๋ธ”์ŠˆํŒ… ๋ชจ์Œ](https://velog.io/@hijuwon/%EB%B0%B1%ED%98%B8-Veco-%ED%8A%B8%EB%9F%AC%EB%B8%94%EC%8A%88%ED%8C%85-%EB%AA%A8%EC%9D%8C) | +| ๐Ÿ ์ด๊ฐ€์„ | [๋‹ค๋ฅธ ๋„๋ฉ”์ธ ๊ฐ„ ์ฟ ํ‚ค ์ด์Šˆ ํ•ด๊ฒฐ๊ธฐ](https://velog.io/@gaeulzzang/๋‹ค๋ฅธ-๋„๋ฉ”์ธ-๊ฐ„-์ฟ ํ‚ค-์ด์Šˆ-ํ•ด๊ฒฐ๊ธฐ) | + +
+
+ +---