From f94aa6f0307c8546724818aac9762a83909141f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=ED=99=8D=EB=8B=A4=EC=97=B0?= <95288297+Dayon-Hong@users.noreply.github.com> Date: Tue, 12 Nov 2024 17:30:36 +0900 Subject: [PATCH] Update README.md --- README.md | 143 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 142 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index acf70cc..9f8175c 100644 --- a/README.md +++ b/README.md @@ -1 +1,142 @@ -# techeermarket-backend + + +# Techeer Market +techeermarkte + + +
+ +## ๐ŸŽ€ Introduction + +ํ…Œ์ปค ๋‚ด ์ค‘๊ณ ๊ฑฐ๋ž˜๋ฅผ ์œ„ํ•œ ์›น ํ”Œ๋žซํผ, ํ…Œ์ปค ๋งˆ์ผ“ ๐Ÿ‘ฉ๐Ÿปโ€๐ŸŒพ +
+
+ +## ๐Ÿ“š Tech Stack + +| Frontend | Backend | Database&Storage | DevOps | Test | +| --- | --- | --- | --- | --- | +| ![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white) ![React Hook Form](https://img.shields.io/badge/React%20Hook%20Form-%23EC5990.svg?style=for-the-badge&logo=reacthookform&logoColor=white)
![Storybook](https://img.shields.io/badge/-Storybook-FF4785?style=for-the-badge&logo=storybook&logoColor=white) |
![JWT](https://img.shields.io/badge/JWT-black?style=for-the-badge&logo=JSON%20web%20tokens)
|

|

![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
|
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
| + + +
+ +## โš™๏ธ System Architecture + +![แ„‰แ…ตแ„‰แ…ณแ„แ…ฆแ†ทแ„‹แ…กแ„แ…ตแ„แ…ฆแ†จแ„Žแ…ง](https://github.com/Techeer-market/.github/assets/95288297/4203200b-027d-465d-b71a-c6dc93f4f540) + + +
+ +## โ›บ๏ธ ERD + +![ERD](https://github.com/Techeer-market/.github/assets/95288297/641c44d6-ce34-4297-95b8-e9fa28b2a089) + + + +
+ +### ๐Ÿ”ย ๊ธฐ๋Šฅ ๊ตฌํ˜„ ๋ฒ”์œ„ + +- **ํšŒ์›** + - ํšŒ์› ๊ฐ€์ž… / ๋กœ๊ทธ์ธ + - ๋งˆ์ดํŽ˜์ด์ง€ + - ํŒ๋งค / ๊ตฌ๋งค ๋‚ด์—ญ ๋ฆฌ์ŠคํŠธ ํ™•์ธ + - ์ข‹์•„์š” ๊ฒŒ์‹œ๋ฌผ ๋ชฉ๋ก + - ํŒ๋งค์ž ์ •๋ณด +- **์ค‘๊ณ  ๊ฑฐ๋ž˜ ์‹œ์Šคํ…œ** + - ์ค‘๊ณ ๊ฑฐ๋ž˜ ๊ฒŒ์‹œ๋ฌผ ๊ธ€์“ฐ๊ธฐ + - ํŒ๋งคํ•  ๋ฌผ๊ฑด ์‚ฌ์ง„ ์—…๋กœ๋“œ + - ๊ฒŒ์‹œ๋ฌผ ๋‚ด์šฉ (์ œ๋ชฉ, ๊ฐ€๊ฒฉ, ์‚ฌ์ง„, ๋‚ด์šฉ, ์›ํ•˜๋Š” ๊ฑฐ๋ž˜ ์œ„์น˜) + - ๊ตฌ๋งค + - ์ฑ„ํŒ… (ํŒ๋งค์ž, ๊ตฌ๋งค์ž ๊ฐ„ 1:1 ์ฑ„ํŒ…) + - ๊ฒŒ์‹œ๋ฌผ ์ƒํƒœ (ํŒ๋งค์ค‘โ†’์˜ˆ์•ฝ์ค‘โ†’๊ตฌ๋งค์™„๋ฃŒ) + - ์ƒ์„ธ ๊ฒŒ์‹œ๋ฌผ ํŽ˜์ด์ง€ + - ์ƒํ’ˆ ๊ฒ€์ƒ‰ (ํ‚ค์›Œ๋“œ) + +
+ +## ๐Ÿ’ป Installation Process + +> Docker repository clone +> + +``` +git clone --recursive +git clone --recursive +``` + +
+ +> Set .env in the backend folder +> + +``` +CLOUD_AWS_DB_HOST= +CLOUD_AWS_DB_DATABASE_NAME= +CLOUD_AWS_DB_USERNAME= +CLOUD_AWS_DB_PASSWORD= + +CLOUD_AWS_S3_BUCKETNAME= +CLOUD_AWS_S3_REGION= +CLOUD_AWS_ACCESS_KEY_ID= +CLOUD_AWS_SECRET_ACCESS_KEY= +``` + +
+ +## ๐Ÿ“Šย Flowchart + +![flowchart](https://github.com/Techeer-market/.github/assets/95288297/1228566c-f532-40a8-9e26-1ed69d17caf1) + + +## ๐Ÿ” Features + +- **ํšŒ์›๊ฐ€์ž…/ ๋กœ๊ทธ์ธ** + - JWT, SpringSecurity ๋ฅผ ์ด์šฉํ•œ ํšŒ์›๊ฐ€์ž…/๋กœ๊ทธ์ธ ํŽ˜์ด์ง€ + - ๋กœ๊ทธ์•„์›ƒ, ํšŒ์› ํƒˆํ‡ด ๊ตฌํ˜„ +- **๋ฉ”์ธํŽ˜์ด์ง€** + - InfiniteScroll์„ ์ด์šฉํ•œ ๊ฒŒ์‹œ๋ฌผ์˜ ๋ชฉ๋ก์„ ๋ณด์—ฌ์ฃผ๋Š” ํŽ˜์ด์ง€ + - AWS S3 ๋žŒ๋‹ค๋ฅผ ์ด์šฉํ•ด ์ธ๋„ค์ผ ๋ฆฌ์‚ฌ์ด์ง• +- **์ „์ฒด ์นดํ…Œ๊ณ ๋ฆฌ ํŽ˜์ด์ง€** +- **๊ฒ€์ƒ‰๊ธฐ๋Šฅ** +- **๊ฒŒ์‹œ๋ฌผ ์ž‘์„ฑ** + - ๋Œ€ํ‘œ์ด๋ฏธ์ง€๋ฅผ ์„ ํƒํ•˜์—ฌ ์ง€์ •ํ•  ์ˆ˜ ์žˆ๊ณ , ๊ฐฏ์ˆ˜๋ฅผ ์ œํ•œํ•˜์—ฌ ์ด 4๊ฐœ ์‚ฌ์ง„ ๊ฒŒ์‹œ ๊ฐ€๋Šฅ + - ์นด์นด์˜ค๋งตAPI๋ฅผ ์ด์šฉํ•˜์—ฌ ์ง€๋„์ƒ ๊ฑฐ๋ž˜ ํฌ๋ง ์žฅ์†Œ๋ฅผ ์„ ์ • ๊ฐ€๋Šฅ +- **๊ฒŒ์‹œ๋ฌผ ์ˆ˜์ •ํ•˜๊ธฐ** + - ๊ฒŒ์‹œ๋œ ๋‚ด์šฉ์„ ์ˆ˜์ •ํ•˜์—ฌ ๊ฒŒ์‹œ ๊ฐ€๋Šฅ +- **๊ฒŒ์‹œ๋ฌผ ์ƒ์„ธ๋ณด๊ธฐ** + - ์นด์นด์˜ค๋งตAPI๋ฅผ ์ด์šฉํ•˜์—ฌ ์ง€๋„์ƒ ๊ฑฐ๋ž˜ ํฌ๋ง ์žฅ์†Œ ํ™•์ธ ๊ฐ€๋Šฅ + - ์ข‹์•„์š” ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ๊ฒŒ์‹œ๋ฌผ์„ ์ข‹์•„์š” ๋ชฉ๋ก์—์„œ ๊ด€๋ฆฌ ๊ฐ€๋Šฅ + - ๊ตฌ๋งค์ž ์™€์˜ ์ฑ„ํŒ… ๊ธฐ๋Šฅ +- **์ฑ„ํŒ…** + - ๊ตฌ๋งค์ž์™€ ํŒ๋งค์ž ์‚ฌ์ด์˜ 1:1 ์ฑ„ํŒ… ๊ฐ€๋Šฅ + - STOMP์˜ pub/sub ๋ฉ”์ปค๋‹ˆ์ฆ˜์„ ํ™œ์šฉํ•˜์—ฌ ํ…์ŠคํŠธ ๊ธฐ๋ฐ˜ ์ฑ„ํŒ… ๊ตฌํ˜„ +- **๋งˆ์ดํŽ˜์ด์ง€** + - ์ข‹์•„์š” ๋ชฉ๋ก, ํŒ๋งค๋‚ด์—ญ, ๊ตฌ๋งค๋‚ด์—ญ ์„ ํƒํ•˜์—ฌ ํ™•์ธ + - ๊ณ„์ •/์ •๋ณด ๊ด€๋ฆฌ์—์„œ ์ด๋ฉ”์ผ, ๋น„๋ฐ€๋ฒˆํ˜ธ, ์ƒ๋…„์›”์ผ ๋“ฑ์˜ ์ •๋ณด ์ˆ˜์ • ๊ฐ€๋Šฅ +- **ํŒ๋งค๋‚ด์—ญ/๊ตฌ๋งค๋‚ด์—ญ** + - ์‚ฌ์šฉ์ž์˜ ํŒ๋งค ๋‚ด์—ญ๊ณผ ๊ตฌ๋งค๋‚ด์—ญ์„ ๊ด€๋ฆฌ ๊ฐ€๋Šฅ + - ํŒ๋งค๋‚ด์—ญ์—์„œ๋Š” ํŒ๋งค ์ค‘, ๊ฑฐ๋ž˜ ์™„๋ฃŒ ์ƒํƒœ๋กœ ๊ตฌ๋ถ„ํ•˜์—ฌ ๊ด€๋ฆฌ ๊ฐ€๋Šฅ +
+ +## โ›น๐Ÿผโ€โ™€๏ธย Postman + +Frontend์™€ Backend ํ†ต์‹ ์„ ์œ„ํ•œ API ๋ฌธ์„œํ™”๋Š” Postman๊ณผ ๋…ธ์…˜์„ ์‚ฌ์šฉํ–ˆ๋‹ค + +https://documenter.getpostman.com/view/27567744/2s9Ykn9N3U + +https://documenter.getpostman.com/view/27567744/2s9Ykn9N3V + +[API ๋ช…์„ธ์„œ](https://www.notion.so/API-9e28dd92dc194e1c85f6e801877a2432?pvs=21) + +
+
+ +## Member +| ์ด๋ฆ„ | ํ™๋‹ค์—ฐ | ๊น€์œ ๋ผ | ์กฐ์€์ฃผ | ํ•˜์žฌ๋ฏผ | ๊ถŒ์ฐฌ์˜ | +| --- | --- | --- | --- | --- | --- | +| ์—ญํ•  | Leader, Backend | Frontend | Frontend | Frontend | Backend | +| ๊นƒํ—ˆ๋ธŒ | [Dayeon-Hong](https://github.com/Dayeon-Hong) | [yura0302](https://github.com/yura0302) | [dmswn1004](https://github.com/dmswn1004) | [penloo](https://github.com/penloo) | [fnzl54](https://github.com/fnzl54) + +