From d7f96baff254f65d86c07c95a20a6db6562ffb17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EC=B5=9C=EB=AF=BC?= <144198706+Minn-Choi@users.noreply.github.com> Date: Sat, 30 Nov 2024 00:27:38 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20README.md=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 154 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 104 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 1e5a46b..9f2c548 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,104 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default tseslint.config({ - languageOptions: { - // other options... - parserOptions: { - project: ['./tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: import.meta.dirname, - }, - }, -}); -``` - -- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` -- Optionally add `...tseslint.configs.stylisticTypeChecked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: - -```js -// eslint.config.js -import react from 'eslint-plugin-react'; - -export default tseslint.config({ - // Set the react version - settings: { react: { version: '18.3' } }, - plugins: { - // Add the react plugin - react, - }, - rules: { - // other rules... - // Enable its recommended rules - ...react.configs.recommended.rules, - ...react.configs['jsx-runtime'].rules, - }, -}); -``` +image + +# ๐Ÿงž์•Œ๋ผ๋”˜ _ Web +**35๊ธฐ AND SOPT ํ•ฉ๋™์„ธ๋ฏธ๋‚˜ ๋ฐ์Šคํฌํƒ‘ ์›น 3์กฐ - ์•Œ๋ผ๋”˜ ๋ ˆํฌ์ง€ํ† ๋ฆฌ ๐Ÿงžโ€โ™‚๏ธ** + + +## ๐Ÿ’ป FE Developer + +| | | | | +| :-----------------: | :-----------------: | :-----------------: | :----------------: | +| **๊ณต์ค€ํ˜** | **๊น€๊ฐ€ํ˜„** | **์†์ง€์œ ** | **์ตœ ๋ฏผ** | +| ๋ฆฌ๋“œ, ํ”„๋ก ํŠธ์—”๋“œ | ํŒ€์›, ํ”„๋ก ํŠธ์—”๋“œ | ํŒ€์›, ํ”„๋ก ํŠธ์—”๋“œ | ํŒ€์›, ํ”„๋ก ํŠธ์—”๋“œ | +| `ํ—ค๋”`,`ํ‘ธํ„ฐ`,`๋ฐฐํฌ` | `์žฅ๋ฐ”๊ตฌ๋‹ˆ` | `๋ฉ”์ธ๋ทฐ ํ•˜๋‹จ` | `๋ฉ”์ธ๋ทฐ ์ƒ๋‹จ` | +| [@ocahs9](https://github.com/ocahs9) | [@maylh](https://github.com/maylh) | [@zzz-myam](https://github.com/zzz-myam) | [@Minn-Choi](https://github.com/Minn-Choi) | + +--- +
+ +## ๐Ÿšฉ ๊ตฌํ˜„ ๊ฒฐ๊ณผ +> **ํ—ค๋”, ํ‘ธํ„ฐ** +
+ image + image +
+ +
+ +> **์žฅ๋ฐ”๊ตฌ๋‹ˆ** +
+ image + image +
+
+ image + image +
+
+ +> **๋ฉ”์ธ๋ทฐ ์ƒ๋‹จ** +
+image +image +
+
+ image + image +
+
+ +> **๋ฉ”์ธ๋ทฐ ํ•˜๋‹จ** +
+image +image +
+ +image +image +
+ + +## ๐Ÿ›  ๊ธฐ์ˆ  ์Šคํƒ + +
+ +| ์—ญํ•  | ์ข…๋ฅ˜ | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 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 | ![Emotion](https://img.shields.io/badge/Emotion-DB7093?style=for-the-badge&logo=emotion&logoColor=white) | +| Data Fetching | ![Axios](https://img.shields.io/badge/Axios-5A29E4?style=for-the-badge&logo=Axios&logoColor=white) | | +| Formatting | ![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white) ![Prettier](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E) ![Stylelint](https://img.shields.io/badge/stylelint-333333?style=for-the-badge&logo=stylelint&logoColor=white") | +| Package Manager | ![Yarn](https://img.shields.io/badge/Yarn-2C8EBB?style=for-the-badge&logo=yarn&logoColor=white) | +| Deployment | ![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white) | + +
+ + +
+ +## ๐Ÿ”ฅ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜ + +| **์ปค๋ฐ‹ ์œ ํ˜•** | **์„ค๋ช…** | +|-------------------|---------------------------------------------------------| +| `init` | ๋ธŒ๋žœ์น˜ ์ฒซ ์ปค๋ฐ‹ | +| `feat` | ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ | +| `fix` | ๋ฒ„๊ทธ ์ˆ˜์ • | +| `docs` | ๋ฌธ์„œ ์ˆ˜์ • | +| `style` | ์ฝ”๋“œ formatting, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์ž์ฒด์˜ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ | +| `refactor` | ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง | +| `test` | ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€ | +| `chore` | ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ๊ทธ ์™ธ ๊ธฐํƒ€ ์ˆ˜์ • ex) .gitignore | +| `build` | ๋นŒ๋“œ ๊ด€๋ จ ํŒŒ์ผ ์ˆ˜์ •์— ๋Œ€ํ•œ ์ปค๋ฐ‹ +| `design` | CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ | +| `comment` | ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ | +| `rename` | ํŒŒ์ผ ๋˜๋Š” ํด๋” ๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ | +| `remove` | ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ | +| `!HOTFIX` | ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ๋ฒ„๊ทธ๋ฅผ ๊ณ ์ณ์•ผ ํ•˜๋Š” ๊ฒฝ์šฐ | +
+ +## ๐Ÿ”— ๋ฐฐํฌ ๋งํฌ + +> [๐Ÿงž์•Œ๋ผ๋”˜ ์„œ๋น„์Šค ๋ฐ”๋กœ๊ฐ€๊ธฐ](https://35-collaboration-web-aladin.vercel.app/) +
+image