From a1d0828fc33bb38cdae7564201ca28d122430748 Mon Sep 17 00:00:00 2001 From: SEOHAEUN <84195580+haeun1107@users.noreply.github.com> Date: Fri, 9 Aug 2024 20:54:53 +0900 Subject: [PATCH] =?UTF-8?q?=08docs:=20readme=20=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 103 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 63 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 76a6b4e..29ee356 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,63 @@ -# AECOFARM-BE -[๐Ÿ‘ฉ๐Ÿปโ€๐ŸŒพ ๊ฐœ๋ฐœ ์ค‘] ๋Œ€ํ•™์ƒ ๊ต๋‚ด ๋ฌผํ’ˆ ๊ณต์œ  ํ”Œ๋žซํผ '์•„์ฝ”ํŒœ' ๋ฐฑ์—”๋“œ - -
- -## Commit Convention - -| ์ปค๋ฐ‹ ์œ ํ˜• | ์„ค๋ช… | -| --- | --- | -| feat | ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€ | -| fix | ๋ฒ„๊ทธ ์ˆ˜์ • | -| docs | ๋ฌธ์„œ ์ˆ˜์ • | -| style | ์ฝ”๋“œ formatting, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ, ์ฝ”๋“œ ์ž์ฒด์˜ ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ | -| refactor | ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง | -| test | ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŒฉํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€ | -| chore | ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •, ๊ทธ ์™ธ ๊ธฐํƒ€ ์ˆ˜์ • ex) .gitignore | -| design | CSS ๋“ฑ ์‚ฌ์šฉ์ž UI ๋””์ž์ธ ๋ณ€๊ฒฝ | -| comment | ํ•„์š”ํ•œ ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ | -| rename | ํŒŒ์ผ ๋˜๋Š” ํด๋” ๋ช…์„ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…๋งŒ์ธ ๊ฒฝ์šฐ | -| remove | ํŒŒ์ผ์„ ์‚ญ์ œํ•˜๋Š” ์ž‘์—…๋งŒ ์ˆ˜ํ–‰ํ•œ ๊ฒฝ์šฐ | -| !BREAKING CHANGE | ์ปค๋‹ค๋ž€ API ๋ณ€๊ฒฝ์˜ ๊ฒฝ์šฐ | -| !HOTFIX | ๊ธ‰ํ•˜๊ฒŒ ์น˜๋ช…์ ์ธ ๋ฒ„๊ทธ๋ฅผ ๊ณ ์ณ์•ผ ํ•˜๋Š” ๊ฒฝ์šฐ | - -
- -## PR Convention - -| ์•„์ด์ฝ˜ | ์ฝ”๋“œ | ์„ค๋ช… | -| --- | --- | --- | -| ๐Ÿง‘๐Ÿปโ€๐ŸŽจ | :art | ์ฝ”๋“œ์˜ ๊ตฌ์กฐ/ํ˜•ํƒœ ๊ฐœ์„  | -| โšก๏ธ | :zap | ์„ฑ๋Šฅ ๊ฐœ์„  | -| ๐Ÿ”ฅ | :fire | ์ฝ”๋“œ/ํŒŒ์ผ ์‚ญ์ œ | -| ๐Ÿ› | :bug | ๋ฒ„๊ทธ ์ˆ˜์ • | -| ๐Ÿš‘ | :ambulance | ๊ธด๊ธ‰ ์ˆ˜์ • | -| โœจ | :sparkles | ์ƒˆ ๊ธฐ๋Šฅ | -| ๐Ÿ’„ | :lipstick | UI/์Šคํƒ€์ผ ํŒŒ์ผ ์ถ”๊ฐ€/์ˆ˜์ • | -| โช | :rewind | ๋ณ€๊ฒฝ ๋‚ด์šฉ ๋˜๋Œ๋ฆฌ๊ธฐ | -| ๐Ÿ”€ | :twisted_rightwards_arrows | ๋ธŒ๋žœ์น˜ ํ•ฉ๋ณ‘ | -| ๐Ÿ’ก | :bulb | ์ฃผ์„ ์ถ”๊ฐ€/์ˆ˜์ • | -| ๐Ÿ—ƒ | :card_file_box | ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๊ด€๋ จ ์ˆ˜์ • | +![aecofarm-main](https://github.com/user-attachments/assets/e97f78e4-f692-4814-bc7a-30599864dee4) +
+**AECOfarm ๋ฐฐํฌ URL** : https://aecofarm.vercel.app + +# โœจIntroduce +## 1. ํ”„๋กœ์ ํŠธ ๋ช… +![readme-page-1](https://github.com/user-attachments/assets/a1bf83dd-20ed-4692-b6a1-b134276affd9) +๋Œ€ํ•™์ƒ ๊ต๋‚ด ๋ฌผํ’ˆ ๊ณต์œ  ํ”Œ๋žซํผ, ์•„์ฝ”ํŒœ +
+
+ +## 2. ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ +์•„์ฝ”ํŒœ์€ ๋Œ€ํ•™์ƒ๋“ค์ด ๊ต๋‚ด์—์„œ ํ•„์š”ํ•œ ๋ฌผํ’ˆ์„ ์‰ฝ๊ฒŒ ๊ณต์œ ํ•˜๊ณ  ๋Œ€์—ฌํ•  ์ˆ˜ ์žˆ๋Š” ํ”Œ๋žซํผ์ด๋‹ค. ๋ถˆํ•„์š”ํ•œ ๊ตฌ๋งค๋ฅผ ์ค„์—ฌ ์ž์›์„ ์žฌํ™œ์šฉํ•˜๊ณ  ๊ฒฝ์ œ์  ๋ถ€๋‹ด์„ ๋œ๋ฉฐ, ์นœํ™˜๊ฒฝ์  ๋ฐœ์ „์„ ์ด๋ฃฌ๋‹ค. ๋˜ํ•œ, ๋ฌผํ’ˆ ๊ณต์œ ๋ฅผ ํ†ตํ•ด ๋Œ€ํ•™ ๋‚ด ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ๊ฐ•ํ™”ํ•˜๊ณ  ์ง€์† ๊ฐ€๋Šฅํ•œ ์บ ํผ์Šค ๋ฌธํ™”๋ฅผ ์กฐ์„ฑํ•˜๊ณ ์ž ํ•œ๋‹ค. +
+
+ +## 3. ๊ธฐ๋Šฅ ์†Œ๊ฐœ +### 1๏ธโƒฃ ๊ฑฐ๋ž˜ ๊ฒŒ์‹œํŒ(๋Œ€์—ฌํ•˜๊ธฐ/๋นŒ๋ ค์ฃผ๊ธฐ) +![readme-page-2](https://github.com/user-attachments/assets/dbc016c6-2453-4661-a57c-9c5faaa5ea1b) +
+ +### 2๏ธโƒฃ ์‹ค๋ช… ๊ธฐ๋ฐ˜ ๊ฑฐ๋ž˜ +![readme-page-3](https://github.com/user-attachments/assets/25399dcb-fa85-47e2-afd4-ddbef00743f3) +
+ +### 3๏ธโƒฃ ํ‚ค์›Œ๋“œ ๊ธฐ๋ฐ˜ ๊ฒ€์ƒ‰ +![readme-page-4](https://github.com/user-attachments/assets/573f2ccd-9c08-47ca-ba2e-27098a293633) +
+ +### 4๏ธโƒฃ ๋งˆ์ดํŽ˜์ด์ง€ ๊ด€๋ฆฌ +![readme-page-5](https://github.com/user-attachments/assets/f6567e73-6037-4537-b88f-6452c302c72e) +
+
+ +## ๐Ÿ’ป ์‹œ์—ฐ ์˜์ƒ +[์‹œ์—ฐ์˜์ƒ ๋ณด๋Ÿฌ๊ฐ€๊ธฐ](https://www.youtube.com/watch?v=LxEjWi7tbL4) +
+
+
+ +# ๐Ÿ”ง Architecture +![readme-page-6](https://github.com/user-attachments/assets/b4188b0a-f7c3-445b-a1ba-48ea23106c8a) +
+
+
+ +# ๐Ÿ› ๏ธ Tech + +
+ +
+
+
+ +# ๐Ÿ‘‹ AECOfarm Team + +| ์ด๋ฆ„ | ์ „๊ณต | Email | +| ------------------------------------ | ------------------- | --------------------- | +| [์„œํ•˜์€](https://github.com/haeun1107) | ๋™๊ตญ๋Œ€ํ•™๊ต ์ปดํ“จํ„ฐ๊ณตํ•™์ „๊ณต | haeun9394@gmail.com | +| [์„œ์€์ •](https://github.com/enunsnv) | ๋™๊ตญ๋Œ€ํ•™๊ต ์ปดํ“จํ„ฐ๊ณตํ•™์ „๊ณต | seoej0315@naver.com | +| [์ด์ •์„ ](https://github.com/leejs0823) | ๋™๊ตญ๋Œ€ํ•™๊ต ์ปดํ“จํ„ฐ๊ณตํ•™์ „๊ณต | dlwjdtjs0111@gmail.com | +| [์ตœ์˜ˆ์ธ](https://github.com/YeahOut) | ๋™๊ตญ๋Œ€ํ•™๊ต ์ปดํ“จํ„ฐ๊ณตํ•™์ „๊ณต | pt840072@naver.com | +