From fc3979f310893131b05acbb19f75b66d42c25771 Mon Sep 17 00:00:00 2001 From: miensoap Date: Mon, 2 Dec 2024 23:57:44 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EB=A6=AC=EB=93=9C=EB=AF=B8=EC=97=90=20?= =?UTF-8?q?=ED=95=B5=EC=8B=AC=20=EA=B2=BD=ED=97=98=20=EC=9A=94=EC=95=BD,?= =?UTF-8?q?=20=EB=B0=B0=ED=8F=AC=20=EB=A7=81=ED=81=AC=20=EC=B6=94=EA=B0=80?= =?UTF-8?q?=20/=20=EC=88=9C=EC=84=9C=20=EB=B3=80=EA=B2=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 103 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 78 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index c5e727e7..ce696664 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,10 @@ -
- ์˜ค๋Š˜์˜ ๊ธธ -
- ---- - -๐Ÿ“ ํ”ผ๋“œ๋ฐฑ์„ ๋‚จ๊ฒจ์ฃผ์„ธ์š”! +## [์—ฌ๊ธฐ์„œ ๋‚˜๋งŒ์˜ ์ง€๋„๋ฅผ ๊ณต์œ ํ•ด ๋ณด์„ธ์š”! ๐Ÿš—](https://preview.dailyroad.site/) -### ํŒ€์› ์†Œ๊ฐœ - -| [J088\_๋„์›์ง„](https://github.com/1119wj) | [J151\_์•ˆ๊ธˆ์žฅ](https://github.com/koomchang) | [J105\_๋ฐ•๋ฏผ์„œ](https://github.com/Miensoap) | [J270 \_ํ•œ๋™ํšจ](https://github.com/hyohyo12) | -|:--------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|:---------------------------------------------------------------------------:| -| | | | | -| FE | BE | BE | BE | +
+ + ์˜ค๋Š˜์˜ ๊ธธ + +
### ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ @@ -22,37 +15,97 @@ > > ๊ฐœ์ธ์ ์ธ ๊ธฐ์–ต๊ณผ ๊ฐ์ƒ์„ ๋‹ด์€ ์ง€๋„๋ฅผ ํ†ตํ•ด ์ƒˆ๋กœ์šด ๋ฐœ๊ฒฌ์„ ํ•˜๊ณ , > ์ผ์ƒ์˜ ์˜๊ฐ์„ ์–ป์–ด๋ณด์„ธ์š”! +> +> ๐Ÿ“ ํ”ผ๋“œ๋ฐฑ์„ ๋‚จ๊ฒจ์ฃผ์„ธ์š”! -### ๊ธฐ์ˆ  ์Šคํƒ +
+
+ +### ํ•ต์‹ฌ ๊ธฐ๋Šฅ --- -| **๋„๋ฉ”์ธ** | **๊ธฐ์ˆ  ์Šคํƒ** | -|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **๊ณตํ†ต** | ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=ffffff) ![Prettier](https://img.shields.io/badge/Prettier-F7B93E?logo=prettier&logoColor=ffffff) ![ESLint](https://img.shields.io/badge/ESLint-4B32C3?logo=eslint&logoColor=ffffff) | -| **ํ”„๋ก ํŠธ์—”๋“œ** | ![Vite](https://img.shields.io/badge/Vite-646CFF?logo=Vite&logoColor=ffffff) ![React](https://img.shields.io/badge/React-61DAFB?logo=React&logoColor=ffffff) ![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-06B6D4?logo=tailwindcss&logoColor=ffffff) ![React Query](https://img.shields.io/badge/React_Query-FF4154?logo=reactquery&logoColor=ffffff) ![Zustand](https://img.shields.io/badge/Zustand-443E38?logo=react&logoColor=ffffff) | -| **๋ฐฑ์—”๋“œ** | ![Node.js](https://img.shields.io/badge/Node.js-114411?logo=node.js) ![NestJS](https://img.shields.io/badge/NestJS-E0234E?logo=nestjs&logoColor=ffffff) ![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=ffffff) ![TypeORM](https://img.shields.io/badge/TypeORM-3178C6?logo=typeorm&logoColor=ffffff) ![Elasticsearch](https://img.shields.io/badge/Elasticsearch-005571?logo=elasticsearch&logoColor=ffffff) ![Kibana](https://img.shields.io/badge/Kibana-005571?logo=kibana&logoColor=ffffff) ![Logstash](https://img.shields.io/badge/Logstash-005571?logo=logstash&logoColor=ffffff) | -| **๋ฐฐํฌ** | ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?logo=githubactions&logoColor=ffffff) ![Nginx](https://img.shields.io/badge/nginx-014532?logo=Nginx&logoColor=009639&) ![Naver Cloud Platform](https://img.shields.io/badge/Naver%20Cloud%20Platform-03C75A?logo=naver&logoColor=ffffff) | -| **ํ˜‘์—… ๋„๊ตฌ** | ![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=ffffff) ![Notion](https://img.shields.io/badge/Notion-000000?logo=notion) ![Figma](https://img.shields.io/badge/Figma-F24E1E?logo=figma&logoColor=ffffff) ![Slack](https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=ffffff) | +### ๋‚˜๋งŒ์˜ ์ง€๋„ ๋งŒ๋“ค๊ธฐ + +> ์žฅ์†Œ ๊ฒ€์ƒ‰ํ•˜๊ธฐ +> ํ•€ ์ถ”๊ฐ€ํ•˜๊ธฐ + +### ๋‚˜๋งŒ์˜ ์ฝ”์Šค ๋งŒ๋“ค๊ธฐ + +> ๊ฒฝ๋กœ ํ‘œ์‹œ

-### ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜ +### ํ•ต์‹ฌ ๊ฒฝํ—˜ + +_๋” ์ž์„ธํžˆ ๋ณด๋ ค๋ฉด ์ œ๋ชฉ์„ ํด๋ฆญํ•ด ์ฃผ์„ธ์š”!_ --- -์•„ํ‚คํ…์ฒ˜ +### [Elasticsearch ๋ฅผ ์‚ฌ์šฉํ•œ ๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ ๊ฐœ์„ ]() + +> Elasticsearch๋ฅผ ๋„์ž…ํ•ด ๊ฒ€์ƒ‰ ๋กœ์ง์˜ ๊ฐ€์ค‘์น˜๋ฅผ ์กฐ์ •ํ•˜๊ณ  RDB์™€ ๋™๊ธฐํ™”๋ฅผ ์œ ์ง€ํ•˜์—ฌ ๊ฒ€์ƒ‰ ์ •ํ™•๋„๋ฅผ ๊ฐœ์„ ํ–ˆ์Šต๋‹ˆ๋‹ค. +> ์‹ฑ๊ธ€ ๋…ธ๋“œ ํ™˜๊ฒฝ์—์„œ์˜ ์žฅ์•  ์ƒํ™ฉ์— ๋Œ€๋น„ํ•ด SFP ๋Œ€์ฒ˜ ๋กœ์ง์„ ์ถ”๊ฐ€ํ–ˆ๊ณ , +> ๊ฒฐ๊ณผ์ ์œผ๋กœ ๋™์˜์–ด ์ฒ˜๋ฆฌ์™€ ์˜คํƒ€ ๊ต์ • ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ๊ฒ€์ƒ‰ ์‹ ๋ขฐ๋„๋ฅผ ๋†’์˜€์Šต๋‹ˆ๋‹ค. + +### [๋งˆ์ปค ํด๋Ÿฌ์Šคํ„ฐ๋ง]() + +> ์ง€๋„ ์ƒ ์ˆ˜๋งŽ์€ ๋งˆ์ปค๋ฅผ ํšจ๊ณผ์ ์œผ๋กœ ํ‘œํ˜„ํ•˜๊ธฐ ์œ„ํ•ด ์œ„ํ•ด ํด๋Ÿฌ์Šคํ„ฐ๋ง์„ ๋„์ž…ํ–ˆ์Šต๋‹ˆ๋‹ค. +> ๊ทธ ๊ณผ์ •์—์„œ ๋งˆ์ปค์˜ ๊ณผ๋„ํ•œ ๋ Œ๋”๋ง๊ณผ ๊นœ๋นก์ž„ ๋ฌธ์ œ๋ฅผ ๋งŒ๋‚ฌ์Šต๋‹ˆ๋‹ค. +> ์ด๋ฅผ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•ด ๋ Œ๋”๋ง ์กฐ๊ฑด์„ ์ตœ์ ํ™”ํ•จ์œผ๋กœ์จ ๋ Œ๋”๋ง ๋นˆ๋„๋ฅผ ์ค„์ด๊ณ , ์‚ฌ์šฉ์ž ๊ฒฝํ—˜์„ ํ–ฅ์ƒ์‹œ์ผฐ์Šต๋‹ˆ๋‹ค. + +### [๋กœ๊ทธ ๋ชจ๋‹ˆํ„ฐ๋ง ์‹œ์Šคํ…œ]() + +> ๋กœ๊น… ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ์™€ ๋กœ๊ทธ ๋ ˆ๋ฒจ ๊ธฐ์ค€์„ ๋ช…ํ™•ํžˆ ํ•˜๊ณ , +> Kibana์™€ Slack์„ ์—ฐ๋™ํ•ด ์‹ค์‹œ๊ฐ„ ๋ชจ๋‹ˆํ„ฐ๋ง ์‹œ์Šคํ…œ์„ ๊ตฌ์ถ•ํ–ˆ์Šต๋‹ˆ๋‹ค. +> ์ด๋ฅผ ํ†ตํ•ด ์„œ๋ฒ„ ์žฅ์•  ์‹œ ๋ฌธ์ œ ํŒŒ์•…์ด ๋นจ๋ผ์กŒ๊ณ , ์šด์˜ ์‹ ๋ขฐ๋„๋ฅผ ํ–ฅ์ƒ์‹œ์ผฐ์Šต๋‹ˆ๋‹ค. + +### [ํ…Œ์ŠคํŠธ]() + +> ๋ชจํ‚น ์—†์ด ์‹ค์ œ ํ™˜๊ฒฝ๊ณผ ์œ ์‚ฌํ•œ ์กฐ๊ฑด์—์„œ ํ…Œ์ŠคํŠธ๋ฅผ ์ˆ˜ํ–‰ํ–ˆ์Šต๋‹ˆ๋‹ค. +> ์ปจํ…Œ์ด๋„ˆ๋ฅผ ์‚ฌ์šฉํ•ด ๋‹ค์–‘ํ•œ ํ™˜๊ฒฝ์—์„œ ์•ˆ์ •์ ์œผ๋กœ ํ…Œ์ŠคํŠธ๋ฅผ ์ง„ํ–‰ํ–ˆ์œผ๋ฉฐ, +> ์ด๋ฅผ ํ†ตํ•ด ๋ฆฌํŒฉํ„ฐ๋ง ๋ฐ ๋ฒ„๊ทธ ์ˆ˜์ • ์‹œ ์ ๊ฒ€์ด ์šฉ์ดํ•ด์กŒ๊ณ , ์ฝ”๋“œ ํ’ˆ์งˆ๊ณผ ์‹ ๋ขฐ๋„๊ฐ€ ํ–ฅ์ƒ๋˜์—ˆ์Šต๋‹ˆ๋‹ค. + +### [React๋กœ ๋ž˜ํ•‘๋˜์ง€ ์•Š์€ JS ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์‚ฌ์šฉ]() + +> JS ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ์™€ React์˜ ๊ฒฐํ•ฉ ๊ณผ์ •์—์„œ ๋†’์€ ์ž์œ ๋„๋กœ ์ธํ•ด +> ๋งˆ์ปค ๊ด€๋ฆฌ ์ฃผ์ฒด๊ฐ€ ๋ถ„์‚ฐ๋˜๋Š” ๋ฌธ์ œ๋ฅผ ๊ฒช์—ˆ์Šต๋‹ˆ๋‹ค. +> ์ด๋ฅผ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•ด ์ฝ”๋“œ ์ž‘์„ฑ ๊ทœ์น™์„ ์ •๋ฆฝํ•ด ๋งˆ์ปค ๊ด€๋ฆฌ ์ฒด๊ณ„๋ฅผ ํ†ตํ•ฉํ•˜๊ณ , ์‚ฌ์šฉ์„ฑ๊ณผ ์•ˆ์ •์„ฑ์„ ๊ฐœ์„ ํ–ˆ์Šต๋‹ˆ๋‹ค.

-### ํ•ต์‹ฌ ๊ฒฝํ—˜ +### ๊ธฐ์ˆ  ์Šคํƒ + +--- + +| **๋„๋ฉ”์ธ** | **๊ธฐ์ˆ  ์Šคํƒ** | +| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **๊ณตํ†ต** | ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=ffffff) ![Prettier](https://img.shields.io/badge/Prettier-F7B93E?logo=prettier&logoColor=ffffff) ![ESLint](https://img.shields.io/badge/ESLint-4B32C3?logo=eslint&logoColor=ffffff) | +| **ํ”„๋ก ํŠธ์—”๋“œ** | ![Vite](https://img.shields.io/badge/Vite-646CFF?logo=Vite&logoColor=ffffff) ![React](https://img.shields.io/badge/React-61DAFB?logo=React&logoColor=ffffff) ![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-06B6D4?logo=tailwindcss&logoColor=ffffff) ![React Query](https://img.shields.io/badge/React_Query-FF4154?logo=reactquery&logoColor=ffffff) ![Zustand](https://img.shields.io/badge/Zustand-443E38?logo=react&logoColor=ffffff) | +| **๋ฐฑ์—”๋“œ** | ![Node.js](https://img.shields.io/badge/Node.js-114411?logo=node.js) ![NestJS](https://img.shields.io/badge/NestJS-E0234E?logo=nestjs&logoColor=ffffff) ![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=ffffff) ![TypeORM](https://img.shields.io/badge/TypeORM-3178C6?logo=typeorm&logoColor=ffffff) ![Elasticsearch](https://img.shields.io/badge/Elasticsearch-005571?logo=elasticsearch&logoColor=ffffff) ![Kibana](https://img.shields.io/badge/Kibana-005571?logo=kibana&logoColor=ffffff) ![Logstash](https://img.shields.io/badge/Logstash-005571?logo=logstash&logoColor=ffffff) | +| **๋ฐฐํฌ** | ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?logo=githubactions&logoColor=ffffff) ![Nginx](https://img.shields.io/badge/nginx-014532?logo=Nginx&logoColor=009639&) ![Naver Cloud Platform](https://img.shields.io/badge/Naver%20Cloud%20Platform-03C75A?logo=naver&logoColor=ffffff) | +| **ํ˜‘์—… ๋„๊ตฌ** | ![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=ffffff) ![Notion](https://img.shields.io/badge/Notion-000000?logo=notion) ![Figma](https://img.shields.io/badge/Figma-F24E1E?logo=figma&logoColor=ffffff) ![Slack](https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=ffffff) | + +
+
+ +### ์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜ --- +์•„ํ‚คํ…์ฒ˜ +

+### ํŒ€์› ์†Œ๊ฐœ + +| [J088\_๋„์›์ง„](https://github.com/1119wj) | [J151\_์•ˆ๊ธˆ์žฅ](https://github.com/koomchang) | [J105\_๋ฐ•๋ฏผ์„œ](https://github.com/Miensoap) | [J270 \_ํ•œ๋™ํšจ](https://github.com/hyohyo12) | +| :------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :-------------------------------------------------------------------------: | +| | | | | +| FE | BE | BE | BE | + | ๐Ÿท๏ธ ๋ฐ”๋กœ๊ฐ€๊ธฐ | [**ํŒ€ Notion**](https://elastic-bread-9ef.notion.site/12963e6f4ee98074b6f9f70cfa9ac836) | [์œ„ํ‚ค](https://github.com/boostcampwm-2024/web09-DailyRoad/wiki) | -|:--------:|:--------------------------------------------------------------------------------------:|:--------------------------------------------------------------:| +| :---------: | :-------------------------------------------------------------------------------------: | :--------------------------------------------------------------: |