From 3110745a56223f2078f1ce8a45f2d7681b4e64a9 Mon Sep 17 00:00:00 2001
From: Kim Do Yeon <144890194+tkv00@users.noreply.github.com>
Date: Sun, 15 Dec 2024 17:02:42 +0900
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=95docs:Update=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 86 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 851f933..277a419 100644
--- a/README.md
+++ b/README.md
@@ -13,37 +13,99 @@ Yeungnam Nyang frontend repository
 | :pushpin: | chore | 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignore |
 
 # Architecture
-```
-├── App.jsx
+## 폴더 구조
+<details>
+  <summary>Yeungnam-Nyang-FE</summary>
+
+  ```
+  ├── App.jsx
 ├── api
-│   └── test.txt
-├── assets
-│   ├── font
-│   ├── images
+│   └── api.jsx
 ├── components
+│   ├── common
+│   │   ├── Button.jsx
+│   │   ├── ButtonNopic.jsx
+│   │   ├── DropMenu.jsx
+│   │   ├── Error.jsx
+│   │   ├── Header.jsx
+│   │   ├── Loading.jsx
+│   │   ├── Logo.jsx
+│   │   ├── Modal.jsx
+│   │   ├── NavBar.jsx
+│   │   ├── Title.jsx
+│   │   └── Wrapper.jsx
+│   ├── friend
+│   │   ├── FriendList.jsx
+│   │   └── FriendRequest.jsx
+│   ├── main
+│   │   └── PostPreview.jsx
+│   ├── nyangmap
+│   │   ├── CatMarker.jsx
+│   │   ├── KakaoMap.jsx
+│   │   └── NyangBox.jsx
+│   └── post
+│       ├── DetailPostComment.jsx
+│       ├── DetailPostCommentInput.jsx
+│       ├── DetailPostContent.jsx
+│       ├── DetailPostHeader.jsx
+│       ├── DetailPostImage.jsx
+│       ├── StopWatch.css
+│       └── StopWatch.jsx
 ├── data
+│   └── test.txt
 ├── hooks
+│   ├── useFetch.jsx
+│   ├── useFileUpload.jsx
+│   ├── useGeoLocation.jsx
+│   ├── useLocationPermission.jsx
+│   └── useOutsideClick.jsx
+├── index.css
 ├── main.jsx
 ├── pages
 │   ├── CatsMap.jsx
+│   ├── Friend.jsx
+│   ├── FriendProfile.jsx
+│   ├── FriendReceive.jsx
+│   ├── FriendSent.jsx
 │   ├── Login
+│   │   ├── FindId.css
 │   │   ├── FindId.jsx
+│   │   ├── FindPassword.css
 │   │   ├── FindPassword.jsx
+│   │   ├── Login.css
 │   │   └── Login.jsx
 │   ├── Main.jsx
+│   ├── NotFound.jsx
+│   ├── Post
+│   │   ├── DetailPost.jsx
+│   │   ├── EditPost.jsx
+│   │   └── WritePost.jsx
 │   ├── Profile
+│   │   ├── EditProfile.css
 │   │   ├── EditProfile.jsx
-│   │   ├── MyCats.jsx
-│   │   ├── MyProfile.jsx
-│   │   └── SavedPosts.jsx
-│   ├── SignUp
-│   │   ├── SignUP1.jsx
-│   │   └── SignUp2.jsx
-│   └── TodayCat.jsx
+│   │   ├── EditProfile2.jsx
+│   │   ├── MyProfile.css
+│   │   └── MyProfile.jsx
+│   ├── Scrap.jsx
+│   └── SignUp
+│       ├── SignUP1.jsx
+│       ├── SignUp1.css
+│       └── SignUp2.jsx
+├── setupProxy.js
 ├── store
+│   ├── AuthProvider.jsx
+│   ├── commentInputStore.jsx
+│   └── useCatMapPosts.jsx
 ├── styles
+│   ├── animation.js
+│   └── test.txt
 └── utils
-```
+    ├── PrivateRoutes.jsx
+    ├── dateCalculator.js
+    └── getAddressApi.js
+  ```
+
+
 - components : 재사용 가능한 컴포넌트
 - assets : 이미지 혹은 폰트
 - data : 로컬상에서 사용되는 데이터
@@ -53,3 +115,13 @@ Yeungnam Nyang frontend repository
 - api : 서버통신 api
 - store : zustand,contextAPI상태관리
 - utils : 정규표현식 패턴,공통 함수등
+</details>
+
+
+## 서비스 흐름도
+
+![제목 없는 다이어그램 drawio](https://github.com/user-attachments/assets/64c58c07-4701-41a0-993e-807f700ca593)
+
+## system architecture
+
+