docs: Update README.md

samtuap · Nov 13, 2024 · 02d185d · 02d185d
1 parent 812380d
commit 02d185d
Showing 1 changed file with 292 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,293 @@
-# dongsanginong-client
+![KakaoTalk_20241020_232028824 (1)](https://github.com/user-attachments/assets/ebddec83-3ba9-4b0e-8782-79c936fc5b75)
 
-🥕 동상이농 클라이언트 리포지토리
+<div align=center>
+
+  **🥦[Play Data] 한화시스템 BEYOND SW캠프 7기/삼투압🥦**
+</div>
+
+<br><br> 
+
+## 🧑🏻‍🌾 프로젝트 개요
+
+<div>
+
+  **"농가와 소비자를 연결하는 농산물 구독 서비스"** <br>
+</div>
+
+‘동상이농(同床利農)’ 은 소비자와 농가가 각기 다른 이익을 추구하면서도 공통의 가치를 공유할 수 있는 혁신적인 농산물 구독 플랫폼입니다. <br>
+‘같은 상상, 서로 다른 이익’ 이라는 뜻을 가진 이름으로, 여기서 '이(利)'와 ‘농(農)'은 소비자와 농가 모두에게 이익을 가져다 주는 지속 가능한 농업을 의미합니다. <br>
+즉, 동상이농 플랫폼은 소비자와 농가 모두 상호 이익을 실현할 수 있는 방향으로 함께 나아가고자 하는 목표를 함축하고 있습니다. <br> <br>
+동상이농은 기존 서비스와의 차별점을 “농산물과 정기 구독에 특화된 서비스"로 잡았습니다. <br>
+상품의 종류가 제한적인 기존 서비스와의 차별점을 두어 다양한 농산물을 정기 구독할 수 있도록 하여 구매자의 선택의 폭을 넓히는 서비스를 기획하였습니다. <br>
+또한 연출된 사진으로만 상품을 확인할 수 있는 기존 서비스와는 달리, <br> 
+라이브 커머스를 통해서 농산물의 상태를 영상으로 확인하고 농가와 밀접하게 소통할 수 있다는 점이 동상이농만의 강점입니다.
+<br><br>
+
+## 📝 요구 사항 명세서
+![요구사항2](https://github.com/user-attachments/assets/43ee6794-4718-45e6-acca-9bacc78dfb39)
+
+<div align=center>
+
+  [⬆️요구 사항 명세 보기](https://quark-smile-890.notion.site/2b8b00aecbba447b970c7908a93fc79f?v=7147478c4da24e92acf2953eb02ae777&pvs=4)
+</div>
+
+<br><br>
+
+## 🗓️ WBS
+![image](https://github.com/user-attachments/assets/db3d8340-3da9-4268-8da9-be6f87512711)
+
+<div align=center>
+
+  [⬆️WBS 보기](https://docs.google.com/spreadsheets/d/1WE7JiiPJ6AdVeDdM6F6V6v_KpRaB3TVqzRiomrheFI0/edit?gid=0#gid=0)
+</div>
+
+<br><br>
+
+## ☁️ ERD
+![dongsanginong-erd](https://github.com/user-attachments/assets/2a2cbefa-3494-4382-b800-d6f03dd82ea0)
+<div align=center>
+
+  [⬆️ERD CLOUD 바로가기](https://www.erdcloud.com/d/AgNZCZGaBx6NE8JhL)
+</div>
+
+<br><br>
+
+## ⚙️ 시스템 아키텍처
+<img width="1324" alt="전체" src="https://github.com/user-attachments/assets/58138f35-17d1-4811-bdb8-8a5a9fb98f7c">
+
+<details>
+  <summary>WebRTC + OpenVidu 다이어그램</summary>
+  <br>
+
+  <img src="https://github.com/user-attachments/assets/ae488213-562f-4c3c-b248-210d3befd383" width=800>
+  <br>
+</details>
+
+<details>
+  <summary>OpenSearch 다이어그램</summary>
+  <br>
+
+  <img src="https://github.com/user-attachments/assets/2fee3d31-4374-42be-a7e2-14874df80933" width=800>
+
+</details>
+
+<details>
+  <summary>PortOne 결제 다이어그램</summary>
+  <br>
+
+  <img src="https://github.com/user-attachments/assets/f29b44a3-a614-4295-b0e8-c82487c3b1a5" width=800>
+
+</details>
+
+<br><br>
+
+## 📈 프로그램사양서
+<div align=center>
+
+  <img src="https://github.com/user-attachments/assets/a9d7bdc9-7773-4769-89d2-0e4797d1b094" width=250>
+
+  [⬆️API 명세서 보기](https://documenter.getpostman.com/view/37325338/2sAXxLDEqJ#9c2ba4c5-6901-44e7-ad72-8bc8495ab8e0)
+</div>
+
+<br><br>
+
+## 🧪 UI/UX 단위 테스트 결과서
+### 🔍 MAIN PAGE
+
+<details>
+  <summary>메인페이지</summary>
+  <br>
+
+  * 메인페이지<br>
+    ![main](https://github.com/user-attachments/assets/80c58314-f735-49df-bd09-4eb76a0d580c)
+
+
+
+
+
+</details>
+
+<details>
+  <summary>검색</summary>
+  <br>
+
+  * 농장 및 패키지 상품 검색하기<br>
+    ![오픈서치4](https://github.com/user-attachments/assets/caa78397-5b4c-4077-83e2-d7277a4613c8)
+    <br>
+    ![오픈서치5](https://github.com/user-attachments/assets/9f78aad5-15a5-4275-af9f-a0430f6b1376)
+
+</details>
+
+<details>
+  <summary>알림</summary>
+  <br>
+
+  * 구매자 공지글 알림 - 스크랩 한 농장에 공지글이 올라오면 알림<br>
+    ![공지알림](https://github.com/user-attachments/assets/443d6190-8ca5-4cf7-80d1-3c7669d14e04)
+  * 판매자 구매 알림 - 새로운 주문이 들어오면 알림 <br>
+    ![구매알림](https://github.com/user-attachments/assets/158f6d88-6695-4cf3-b472-f94b11958e51)
+  * 판매자 배송 알림 - 다가오는 배송 알림 <br>
+
+
+</details>
+
+### 👥 MEMBER
+
+<details>
+  <summary>member의 마이페이지</summary>
+  <br>
+
+  * member > 내 배송 목록 조회 <br>
+    ![배송](https://github.com/user-attachments/assets/46e7f8c5-ed92-429e-924f-f54d010158e1)
+  * member > 결제 조회 & 영수증 다운로드 <br>
+    ![결제-영수증](https://github.com/user-attachments/assets/c65d5644-dd37-46bf-aaf1-d1c448a8d5d0)
+  * member > 후기 작성 <br>
+   ![writereview](https://github.com/user-attachments/assets/329bbf2b-123a-44a1-9b9b-73300e1424be)
+
+  * member > 내 구독 조회 & 구독 취소 <br>
+    ![마이페이지-구독취소](https://github.com/user-attachments/assets/2f1b1dc2-1c69-4deb-8a4c-01ed264431fd)
+
+</details>
+
+<details>
+  <summary>seller의 내 농장 관리</summary>
+  <br>
+
+  * seller > 운송장 등록 & 배송 관리 <br>
+    ![운송장 번호 등록](https://github.com/user-attachments/assets/6bd520c0-5828-4f2c-a595-b41bdde1b917)
+  * seller > 상품 등록 <br>
+    ![상품 등록](https://github.com/user-attachments/assets/3698224c-1bb5-473a-ad1d-2e53178dcbc7)
+  * seller > 상품 수정 <br>
+    ![상품 수정](https://github.com/user-attachments/assets/92bb7ce6-e8dd-4516-9950-64caf13cf6ba)
+  * seller > 상품 삭제 <br>
+    ![상품 삭제](https://github.com/user-attachments/assets/9343bac0-5db7-4307-9ee1-d95554f7d968)
+  * seller > 리뷰 리스트, 디테일, 삭제 <br>
+    ![리뷰](https://github.com/user-attachments/assets/4e51ba79-32d5-40bc-9423-3c15eb8a4b27)
+  * seller > 쿠폰 리스트, 등록 <br>
+    ![쿠폰 등록 리스트](https://github.com/user-attachments/assets/ec77a404-069e-45ee-8ba5-92d4bbf796aa)
+
+
+  * seller > 공지(커뮤니티) 등록 <br>
+    ![sellerNotice](https://github.com/user-attachments/assets/5c631f89-3757-4642-a962-dc9b28505ed1)
+
+  * seller > 공지(커뮤니티) 수정 <br>
+    ![sellerNoticeUpdate](https://github.com/user-attachments/assets/6a05a43c-e80c-41bc-84fe-370fe02bc9fe)
+
+
+  * seller > 커뮤니티 디테일, 댓글 조회 & 글 삭제 <br>
+    ![noticeDelete](https://github.com/user-attachments/assets/dd169143-fd6e-4745-9dea-63f31cde0ae6)
+
+
+</details>
+
+
+### 📺 LIVE
+
+<details>
+  <summary>라이브 목록 + 카테고리 필터링</summary>
+  <br>
+
+  * 라이브 목록 + 카테고리 필터링<br>
+    ![라이브 목록-카테고리](https://github.com/user-attachments/assets/a5dd9af1-c48e-413e-9dfa-7e44649a229b)
+
+</details>
+
+<details>
+  <summary>라이브 방송 시청 및 채팅</summary>
+  <br>
+
+  * seller > 라이브 시작하기 <br>
+    ![라이브-시작](https://github.com/user-attachments/assets/2fbd618b-3b85-4aae-836f-2f04b571f7c0)
+  * seller > 라이브 중 쿠폰 등록 <br>
+    ![라이브-쿠폰등록](https://github.com/user-attachments/assets/fc21f579-99c4-4089-bc94-b25e137dae8a)
+  * member > 쿠폰 다운로드 <br>
+    ![라이브-쿠폰발급](https://github.com/user-attachments/assets/ebc2e41b-0e4c-4fb1-bd64-968720dd3cdc)
+  * 라이브 중 member와 seller 채팅  <br>
+    ![라이브-채팅](https://github.com/user-attachments/assets/abea9d09-9373-4ebe-8ff5-c554c4823360)
+  * member 강퇴시키기  <br>
+    ![라이브-강퇴](https://github.com/user-attachments/assets/dd40b70c-1f5e-4b31-b14f-35d9a5ac6785)
+  * 라이브에서 강퇴당한 뒤 구매자의 화면
+    ![quitseller](https://github.com/user-attachments/assets/36d22316-d8b6-4180-ae1c-13032349a709)
+
+</details>
+
+### 💰 ORDER
+
+<details>
+  <summary>상품 조회 및 결제</summary>
+  <br>
+
+  * 상품 디테일 조회 <br>
+    ![packageDetail2](https://github.com/user-attachments/assets/74ec0917-2add-4ea2-abc1-787dea54d87e)
+
+
+  * 상품 디테일 > 리뷰 조회
+    ![packageDetail-review](https://github.com/user-attachments/assets/35a8ef51-fcb2-4450-a8de-4704bdce7b86)
+
+
+  * 상품 주문/결제 <br>
+    ![상품목록-결제](https://github.com/user-attachments/assets/5bee0300-831f-45af-834c-165c5b26d468)
+
+</details>
+
+### 🎁 PRODUCT
+
+<details>
+  <summary>농장 목록</summary>
+  <br>
+
+  * 농장 목록 및 스크랩 <br>
+  ![farmListLike](https://github.com/user-attachments/assets/a2a52d6f-fc0b-4101-b3eb-2c28d37b1848)
+
+
+
+  * 농장 목록 카테고리 필터링 <br>
+  ![farmCategory](https://github.com/user-attachments/assets/c6337843-b34f-4cf9-88f5-94207043392e)
+
+  * 농장 목록 정렬 <br>
+    ![farmSort](https://github.com/user-attachments/assets/e5709b1a-1142-4bd3-8b71-7f567d5d1ddb)
+
+
+  * 농장 목록 검색
+    ![farmSearch](https://github.com/user-attachments/assets/a3ed035a-b5cc-4f4d-8a7f-8b1593569609)
+
+
+
+
+</details>
+
+<details>
+  <summary>농장 디테일</summary>
+  <br>
+
+  * 농장 디테일 - 패키지 목록 <br>
+    ![farmProduct](https://github.com/user-attachments/assets/c200ee14-7751-48b1-b4a9-42b7c1612dc6)
+
+  * 농장 디테일 - 공지 조회 및 댓글달기 <br>
+    ![댓글2](https://github.com/user-attachments/assets/3de30bd6-f0a1-480b-b73a-5c84661317b0)
+  * 농장 디테일 - 리뷰 조회 및 수정 <br>
+    ![packageDetail-review](https://github.com/user-attachments/assets/821997a5-a64d-48ff-bd8f-44e267e81f23)
+
+
+
+</details>
+
+<details>
+  <summary>패키지 상품 목록</summary>
+  <br>
+
+  * 패키지 상품 목록 조회 & 위시리스트<br>
+  ![packageList](https://github.com/user-attachments/assets/6b646ad8-3e8c-4fcf-83b3-bd8cb78149dd)
+
+
+  * 패키지 상품 정렬 <br>
+  ![package sort](https://github.com/user-attachments/assets/99df104d-f530-413b-a6e3-366df984dfb7)
+
+
+
+  * 패키지 상품 검색 <br>
+  ![Package search](https://github.com/user-attachments/assets/e18df0f4-8a6d-4ef6-8474-6383ac6bd42e)
+
+
+</details>
+<br>