Skip to content

Commit

Permalink
πŸ“ Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chaneeii authored Nov 19, 2022
1 parent 7781f29 commit 498acc6
Showing 1 changed file with 110 additions and 1 deletion.
111 changes: 110 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,110 @@
# MacC-TEAM-ZESTY
<div align="center">
<img src="https://user-images.githubusercontent.com/63157395/202863892-3df1a9ee-b495-4222-97b8-ad2fe31c8075.png" width="100" >
</div>
<h2 align="center">ZESTY: 우리 λŒ€ν•™ λ§›μ§‘λ¦¬μŠ€νŠΈ</h2>


<a href="https://apps.apple.com/app/id6443997570" style="display: inline-block; overflow: hidden; border-top-left-radius: 13px; border-top-right-radius: 13px; border-bottom-right-radius: 13px; border-bottom-left-radius: 13px; width: 100px; height: 35px;"> <img src="https://tools.applemediaservices.com/api/badges/download-on-the-app-store/white/en-US?size=250x83&amp;releaseDate=1601596800&h=cf93971b907cb46ebd5dc8f2d957a6ef" alt="Download on the App Store" style="border-top-left-radius: 13px; border-top-right-radius: 13px; border-bottom-right-radius: 13px; border-bottom-left-radius: 13px; width: 100px; height: 35px;"></a>

## Features
![features](https://user-images.githubusercontent.com/63157395/202863894-35c7ea74-3ea9-4715-b6c6-6bc8572bada9.png)

<details>
<summary>Details</summary>

<br/>

1. 우리 λŒ€ν•™κ΅ λ§›μ§‘λ¦¬μŠ€νŠΈ μ°Έκ°€ν•˜κΈ°
- μ†Œμ† λŒ€ν•™μ˜ 이메일을 톡해 우리 λŒ€ν•™ μ‚¬λžŒλ“€λΌλ¦¬ ν”„λΌμ΄λΉ—ν•˜κ²Œ λ§›μ§‘λ¦¬μŠ€νŠΈλ₯Ό λ§Œλ“€μ–΄λ³΄μ„Έμš”
- 광고없이 우리 λŒ€ν•™κ΅ μ‚¬λžŒλ“€μ΄ μΆ”μ²œν•˜λŠ” 우리 λŒ€ν•™κ΅ 찐 맛집을 μ°Ύμ•„λ³΄μ„Έμš”


2. λ§›μ§‘λ¦¬μŠ€νŠΈ
- μš°λ¦¬λŒ€ν•™κ΅ μ‚¬λžŒλ“€μ΄ λ“±λ‘ν•œ 맛집을 ν™•μΈν•΄λ³΄μ„Έμš”
- 검색 κΈ°λŠ₯을 톡해 μ‰½κ²Œ μ°Ύμ•„λ³΄μ„Έμš”
- 맛집에 λŒ€ν•œ 평가 μš”μ•½κ³Ό 졜근 λ“±λ‘ν•œ 사진 리뷰λ₯Ό 톡해 μ–΄λ–€ 메뉴가 μ‘΄μž¬ν•˜λŠ”μ§€ 미리볼 수 μžˆμ–΄μš”


3. 맛집 상세 보기
- 맛집에 λŒ€ν•΄ λ‹€μ–‘ν•œ 상세정보λ₯Ό ν™•μΈν•΄λ³΄μ„Έμš”
- μš°λ¦¬λŒ€ν•™ μ‚¬λžŒλ“€μ΄ 직접 남긴 맛집에 λŒ€ν•œ 평가λ₯Ό μš”μ•½ν•΄μ„œ 확인할 수 μžˆμ–΄μš”
- 맛집 λ¦¬λ·°μ—μ„œ μ‚¬μ§„λ¦¬λ·°λ“€λ§Œ λͺ¨μ•„λ³΄μ„Έμš”. 메뉴λͺ…κ³Ό μŒμ‹μ‚¬μ§„ 그리고 ν‰κ°€κΉŒμ§€ ν•œλˆˆμ— 확인할 수 μžˆμ–΄μš”


4. 맛집좔가
- λ“±λ‘ν•˜λ €λŠ” 맛집을 κ²€μƒ‰ν•˜κ³  무엇을 νŒŒλŠ”μ§€ μ—¬λŸ¬λΆ„μ˜ 학ꡐ μ‚¬λžŒλ“€μ—κ²Œ μ†Œκ°œν•΄μ£Όμ„Έμš”
- 맛집을 μΆ”κ°€ν•˜λ©΄ μΆ”κ°€ν•œ μ‚¬λžŒλ§Œ 받을 수 μžˆλŠ” 맛집 등둝 μΉ΄λ“œκ°€ λ°œκΈ‰λ©λ‹ˆλ‹€. μ €μž₯ν•˜κ³  μΉœκ΅¬λ“€μ—κ²Œ μžλž‘ν•΄λ³΄μ„Έμš”


5. 리뷰 λ“±λ‘ν•˜κΈ°
- μ—¬λŸ¬λΆ„μ˜ 학ꡐ에 μΆ”κ°€λ˜μ–΄ μžˆλŠ” 맛집에 λŒ€ν•΄ ν‰κ°€ν•΄λ³΄μ„Έμš”
- ν‰κ°€ν•œ λ‚΄μš©μ€ 선정맛집을 μ„ μ •ν•˜λŠ”λ° ν™œμš©λ©λ‹ˆλ‹€
- 평가λ₯Ό ν•˜κ³  사진과 메뉴λͺ…을 톡해 ν•΄λ‹Ή λ§›μ§‘μ—μ„œ μ–΄λ–€ 메뉴λ₯Ό λ¨Ήμ—ˆλŠ”μ§€ 리뷰λ₯Ό 남길 수 μžˆμ–΄μš”
- 사진 리뷰λ₯Ό 남기면 μ—¬λŸ¬λΆ„μ˜ μŒμ‹ 사진을 μΆ”κ°€ν•΄μ„œ λ¦¬λ·°μΉ΄λ“œκ°€ λ°œκΈ‰λ©λ‹ˆλ‹€. μ €μž₯ν•˜κ³  μΉœκ΅¬λ“€μ—κ²Œ μžλž‘ν•΄λ³΄μ„Έμš”


6. μ„ μ •λ§›μ§‘λ¦¬μŠ€νŠΈ
- 맛집 μ€‘μ˜ 맛집, μš°λ¦¬ν•™κ΅μ˜ 찐 맛집을 λͺ¨μ•„λ³΄μ„Έμš”
- ZESTY만의 νŠΉλ³„ν•œ μ•Œκ³ λ¦¬μ¦˜μœΌλ‘œ 찐 맛집을 μ„ μ •ν•΄λ“œλ¦½λ‹ˆλ‹€


7. λŒ€ν•™ 정보 확인
- λŒ€ν•™κ΅ 이름을 μ„ νƒν•΄μ„œ μš°λ¦¬ν•™κ΅ λ§›μ§‘λ¦¬μŠ€νŠΈμ— λŒ€ν•œ 톡계λ₯Ό ν™•μΈν•΄λ³΄μ„Έμš”
- μš°λ¦¬ν•™κ΅ μ‚¬λžŒλ“€ λͺ‡ λͺ…이, λͺ‡ 개의 맛집을, λͺ‡ 개의 리뷰λ₯Ό λ‚¨κ²ΌλŠ”μ§€ ν•œλˆˆμ— 보고 μƒˆλ‘œμš΄ μΉœκ΅¬λ“€μ„ μ΄ˆλŒ€ν•  수 μžˆμ–΄μš”

</details>

<br/>

## Requirements

<img width="77" alt="ios-version" src="https://img.shields.io/badge/iOS-15.0%2B-lightgrey">
<img width="100" alt="xcode-version" src="https://img.shields.io/badge/Xcode-13.4.0-informational">


<br/>

## Usage

<b> 1. Install `tuist` </b>

```
curl -Ls https://install.tuist.io | bash
```

<b> 2. Generate project </b>

```
tuist clean // optional
tuist fetch // optional
tuist generate
```

<br/>


## Tech Stack

- MVVM (w/ Clean Architecture Concepts)
- Tuist(Modulization)
- combine
- SnapKit
- Kingfisher
- URLSession
- FirebaseAnalytics
- ( + Tools : JIRA, Swagger, Slack )

<br/>

## More About ZESTY iOS Project
- [Project Structure](https://github.com/DeveloperAcademy-POSTECH/MacC-TEAM-ZESTY/discussions/13)
- [Discussions](https://github.com/DeveloperAcademy-POSTECH/MacC-TEAM-ZESTY/discussions)μ—μ„œ 개발, [μŠ€ν„°λ””](https://github.com/DeveloperAcademy-POSTECH/MacC-TEAM-ZESTY/discussions/categories/study), [λ””μžμΈμ‹œμŠ€ν…œ](https://github.com/DeveloperAcademy-POSTECH/MacC-TEAM-ZESTY/discussions/categories/designsystem) 등에 λŒ€ν•΄ λ…Όμ˜ν•©λ‹ˆλ‹€
- [WiKi](https://github.com/DeveloperAcademy-POSTECH/MacC-TEAM-ZESTY/wiki)μ—μ„œ κ°œλ°œμ»¨λ²€μ…˜μ„ 확인할 수 μžˆμŠ΅λ‹ˆλ‹€

<br/>

## Authors

| <img src="https://github.com/chaneeii.png" width = "150"> | <img src="https://github.com/Lia316.png" width = "150"> | <img src="https://github.com/Chaeho-Min.png" width = "150"> | <img src="https://github.com/Gobans.png" width = "150"> | <img src="https://github.com/tea-hkim.png" width = "150"> | <img src="https://github.com/italsehf.png" width = "150"> |
| :-----------------------------------------: | :---------------------------------------: | :-------------------------------------------: | :---------------------------------------: | :-----------------------------------------: | :-----------------------------------------: |
| [정찬희](https://github.com/chaneeii) | [김지경](https://github.com/Lia316) | [λ―Όμ±„ν˜Έ](https://github.com/Chaeho-Min) | [이λͺ…ν™˜](https://github.com/Gobans) | [κΉ€νƒœν˜Έ](https://github.com/tea-hkim) | [κΈˆλ―Όμ„](https://github.com/italsehf) |

0 comments on commit 498acc6

Please sign in to comment.