Skip to content

Commit

Permalink
πŸ“•docs:Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tkv00 authored Dec 15, 2024
1 parent 2574552 commit 3110745
Showing 1 changed file with 86 additions and 14 deletions.
100 changes: 86 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 : λ‘œμ»¬μƒμ—μ„œ μ‚¬μš©λ˜λŠ” 데이터
Expand All @@ -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


0 comments on commit 3110745

Please sign in to comment.