From 52e5a0f9631156cc8c581d61bd6a8f591006db6d Mon Sep 17 00:00:00 2001 From: HyeJean <57613101+MEGUMMY1@users.noreply.github.com> Date: Mon, 9 Dec 2024 19:06:04 +0900 Subject: [PATCH] Docs: Update Readme --- README.md | 75 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 50 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index ef0e47e..fcf8b06 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,65 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/pages/api-reference/create-next-app). +![image](https://github.com/user-attachments/assets/9ca928c0-d139-4ee5-80f7-5b314c51e705) +## πŸ—ΊοΈ 지도 기반 μ£Όλ³€ 인기 슀포츠 μ‹œμ„€μ„ κ°„νŽΈν•˜κ²Œ νƒμƒ‰ν•˜λŠ” μ›Ή μ„œλΉ„μŠ€, HelloFit +🌐 슀포츠 μ΄μš©κΆŒμ„ λ³΄μœ ν•œ μ‚¬μš©μžλ“€μ€ μˆ˜λ§Žμ€ 슀포츠 μ‹œμ„€κ³Ό κ°•μ’Œλ₯Ό 직접 탐색해야 ν•˜λŠ” 번거둜운 과정을 κ²ͺλŠ”λ‹€. μ‹œμ„€ 및 κ°•μ’Œλ₯Ό μ„ νƒν•˜κΈ° μœ„ν•΄μ„œλŠ” μ‹œμ„€μ˜ μœ„μΉ˜, κ°•μ’Œ 정보, 운영 μ‹œκ°„, 가격 λ“± λ‹€μ–‘ν•œ μš”μ†Œλ₯Ό κ³ λ €ν•΄μ•Ό ν•˜λ©° μ΄λŠ” 맀우 λ³΅μž‘ν•˜κ³  μ‹œκ°„μ΄ μ†Œμš”λ˜λŠ” 과정이닀. λ˜ν•œ κΈ°μ‘΄ 슀포츠 κ°•μ’Œ μ‚¬μ΄νŠΈλŠ” μ‹œμ„€λ“€μ˜ μœ„μΉ˜λ₯Ό κ°œλ³„λ‘œ 확인해야 ν•˜λŠ” λ²ˆκ±°λ‘œμ›€μ΄ μ‘΄μž¬ν•˜λ©°, μ‚¬λžŒλ“€μ΄ μ–΄λ–€ μ‹œμ„€μ„ 많이 μ΄μš©ν•˜λŠ”μ§€ νŠΈλ Œλ“œ 정보λ₯Ό νŒŒμ•…ν•˜κΈ° μ–΄λ ΅λ‹€. -## Getting Started +ν—¬λ‘œν•μ€ β€˜μ§€λ„β€™ 기반 μ‹œμ„€ 탐색, λˆ„μ  μˆ˜κ°•μƒ 데이터 기반 β€˜μ‹œμ„€ νŠΈλ Œλ“œβ€™ μΆ”μ²œ, β€˜μ‹œμ„€ 후기’ μ„œλΉ„μŠ€ λ“± 탐색 κ²½ν—˜μ„ κ°œμ„ ν•  λ‹€μ–‘ν•œ κΈ°λŠ₯을 μ œκ³΅ν•œλ‹€. -First, run the development server: +### πŸ‘‰ [**HelloFit ꡬ경가기**](https://www.hellofit.site/) -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## πŸ’™ μ£Όμš” κΈ°λŠ₯ +![image](https://github.com/user-attachments/assets/5d1ab660-7adf-41f1-9a5a-8abb06b5d86b) -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. +### πŸ‘‹ 지도 기반으둜 κ°€κΉŒμš΄ μ‹œμ„€ κ°„νŽΈν•˜κ²Œ 탐색 + ν—¬λ‘œν•μ€ μ‚¬μš©μž μœ„μΉ˜μ™€ κ°€κΉŒμš΄ 슀포츠 μ‹œμ„€μ„ μ‰½κ²Œ 탐색할 수 μžˆλ„λ‘ 지도 기반의 탐색 κΈ°λŠ₯을 μ œκ³΅ν•œλ‹€. 이λ₯Ό 톡해 μ‚¬μš©μžλŠ” μ‹œμ„€μ˜ μœ„μΉ˜λ₯Ό 일일이 νŒŒμ•…ν•˜μ§€ μ•Šμ•„λ„ 지도λ₯Ό 톡해 μ£Όλ³€ μ‹œμ„€μ„ κ°„νŽΈνžˆ 찾을 수 μžˆλ‹€. λ˜ν•œ, μ’…λͺ©λ³„ λˆ„μ  μˆ˜κ°•μƒ 수 기반으둜 인기 슀포츠 μ’…λͺ© ν•„ν„°λ₯Ό μ œκ³΅ν•œλ‹€. 이 ν•„ν„°λ₯Ό ν™œμš©ν•˜λ©΄ 인기 μžˆλŠ” μ’…λͺ©μ˜ μ‹œμ„€λ“€μ„ μ§€λ„μ—μ„œ ν•œλˆˆμ— 확인할 수 μžˆλ‹€. + +![image](https://github.com/user-attachments/assets/a5e04e32-34a1-490d-9c18-b4e8624d4576) -[API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. +### πŸ‘‹ (일반/μž₯μ• ) 이용ꢌ μœ ν˜• 별 맞좀 정보 제곡 +ν—¬λ‘œν•μ€ 이용ꢌ μ’…λ₯˜μ— 따라 일반, 특수 두가지 λ²„μ „μ˜ μ„œλΉ„μŠ€λ₯Ό μ œκ³΅ν•˜λ©°, 각 λ²„μ „μ—λŠ” λ³΄μœ ν•œ μ΄μš©κΆŒμ— λ§žλŠ” 맞좀 μ‹œμ„€ 및 κ°•μ’Œ 정보λ₯Ό μ œκ³΅ν•œλ‹€. μ‚¬μš©μžλŠ” ν† κΈ€ λ²„νŠΌμ„ 톡해 κ°„λ‹¨ν•˜κ²Œ 버전을 μ „ν™˜ν•˜λ©΄μ„œ 탐색할 수 μžˆλ‹€. 특수 λͺ¨λ“œμ—μ„œλŠ” μž₯애인 μ‚¬μš©μžκ°€ μ‹œμ„€ 선택 μ‹œ κ³ λ €ν•΄μ•Ό ν•˜λŠ” μš”μ†Œκ°€ 많기 λ•Œλ¬Έμ— μž₯μ•  특수 필터와 μ‹œμ„€ μž₯μ•  지원 정보λ₯Ό μ œκ³΅ν•¨μœΌλ‘œμ¨ μ μ ˆν•œ μ‹œμ„€ 선택을 ν•  수 μžˆλ„λ‘ λ•λŠ”λ‹€. -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) instead of React pages. +![image](https://github.com/user-attachments/assets/d2f074a7-810d-4769-9741-8fb1d566cb71) +![image](https://github.com/user-attachments/assets/83b761e2-7807-4bab-a8fe-7062a4e7ac56) -This project uses [`next/font`](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. +### πŸ‘‹ λˆ„μ  μˆ˜κ°•μƒ 수 기반으둜 인기 μžˆλŠ” β€˜μŠ€ν¬μΈ  μ’…λͺ©β€™ μΆ”μ²œ +전체 μ‹œμ„€μ˜ λˆ„μ  μˆ˜κ°•μƒ 수 데이터λ₯Ό μΆ”μΆœν•˜μ—¬ κ°€μž₯ 인기 μžˆλŠ” 슀포츠 μ’…λͺ© ν•„ν„°λ₯Ό μ œκ³΅ν•œλ‹€. 이λ₯Ό 톡해 μ‚¬μš©μžλŠ” 인기 슀포츠 μ’…λͺ©μ„ κ°„νŽΈν•˜κ²Œ νŒŒμ•…ν•  수 μžˆλ‹€. +![image](https://github.com/user-attachments/assets/dcf413ba-4929-468f-9402-a34c5b09ed32) -## Learn More +### πŸ‘‹ 인기 μ‹œμ„€μ˜ νŠΈλ Œλ“œ 정보 제곡(λˆ„μ  μˆ˜κ°•μƒ 수 데이터 기반) +ν—¬λ‘œν•μ€ λˆ„μ  μˆ˜κ°•μƒ 수 데이터λ₯Ό 기반으둜 지역별 인기 μ‹œμ„€ μƒμœ„ 5곳을 μΆ”μ²œν•œλ‹€. λ˜ν•œ 지역 및 μ’…λͺ© ν•„ν„°λ₯Ό μ œκ³΅ν•΄ 쑰건에 λ§žλŠ” 인기 μ‹œμ„€μ„ μ‰½κ²Œ νŒŒμ•…ν•  수 μžˆλ‹€. 이λ₯Ό 톡해 μ‚¬μš©μžλŠ” 슀포츠 μ‹œμ„€μ˜ νŠΈλ Œλ“œλ₯Ό ν•œλ²ˆμ— νŒŒμ•…ν•˜κ³  μ‹œμ„€ 선택을 더 κ°„νŽΈν•˜κ²Œ ν•  수 μžˆλ‹€. -To learn more about Next.js, take a look at the following resources: +![image](https://github.com/user-attachments/assets/1225140e-e9ea-4ae3-a5ee-bfc23a1371f2) -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn-pages-router) - an interactive Next.js tutorial. +### πŸ‘‹ μ‹œμ„€ ν›„κΈ° 및 별점 등둝 κΈ°λŠ₯ 제곡 +μ‚¬μš©μžκ°€ μ‹œμ„€μ— λŒ€ν•œ ν›„κΈ°λ₯Ό μž‘μ„±ν•˜κ³  별점을 남길 수 μžˆλŠ” κΈ°λŠ₯을 μ œκ³΅ν•œλ‹€. μ‹œμ„€ ν›„κΈ° 정보λ₯Ό ν™œμš©ν•˜μ—¬ μ‹œμ„€κ³Ό κ°•μ’Œ ν’ˆμ§ˆ, κ°•μ‚¬μ˜ 전문성을 사전에 확인할 수 μžˆλ‹€. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +![image](https://github.com/user-attachments/assets/01efefb5-cfcd-409c-9378-d208e8134843) -## Deploy on Vercel +### πŸ‘‹ μ‹œμ„€ 찜 κΈ°λŠ₯ 및 관심 μ‹œμ„€ μ•Œλ¦Ό κΈ°λŠ₯ 제곡 +μ‹œμ„€ 찜 κΈ°λŠ₯을 톡해 μ‚¬μš©μžλŠ” 관심 μ‹œμ„€μ„ λ“±λ‘ν•˜κ³  ν•œλˆˆμ— 정리할 수 있으며, μ•Œλ¦Ό νŽ˜μ΄μ§€μ—μ„œ μ‹ κ·œ κ°•μ’Œ κ°œμ„€ 정보λ₯Ό λ°›μ•„ λ²ˆκ±°λ‘œμ›€ 없이 ν•„μš”ν•œ 정보λ₯Ό μ‰½κ²Œ 확인할 수 μžˆλ‹€. + +![image](https://github.com/user-attachments/assets/545eadca-17cf-4f53-9b1f-0ab4f49bec7f) + + + +
+ +## πŸ’š TechStack +![image](https://github.com/user-attachments/assets/d8535dde-0f9a-4b4b-888b-6fdc8ecee161) + + +
+ +## πŸ’™ Architecture +![image](https://github.com/user-attachments/assets/7b01ef9b-12bc-4736-9392-eb26c3917bab) + +
+ + +## πŸ’š Developers +||||| +|:-:|:-:|:-:|:-:| +|μ •μ„±ν˜œ
[@eqypo9](https://github.com/eqypo9)
`ν”„λ‘ νŠΈμ—”λ“œ`|μ‘°ν˜œμ§„
[@MEGUMMY1](https://github.com/MEGUMMY1)
`ν”„λ‘ νŠΈμ—”λ“œ`|μž„μ’…ν›ˆ
[@leemhoon00](https://github.com/leemhoon00)
`λ°±μ—”λ“œ`|ν™μˆ˜μ—°
[@suyeonhong99](https://github.com/suyeonhong99)
`λ””μžμ΄λ„ˆ`| -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/pages/building-your-application/deploying) for more details.