Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs/#120] README.md 업데이트 #121

Merged
merged 1 commit into from
Feb 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @sikkzz @lgrin-byte
* @sikkzz
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Nexters

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
93 changes: 92 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,92 @@
# misik-web
# 영수증 리뷰를 AI로 더 쉽고 즐겁게 Misik

영수증을 촬영하면 AI가 자동으로 맛집 리뷰를 생성해줘요! 🍽️

| Type | Link |
| ------------- | --------------------------------------------------------------- |
| 플레이 스토어 | https://play.google.com/store/apps/details?id=com.nexters.misik |
| 앱 스토어 | |

</br>

## Screenshots

<img width=30% src="https://github.com/user-attachments/assets/6be8235f-80fa-484b-9678-0f791b1d8fe1">
<img width=15% src="https://github.com/user-attachments/assets/e696eedc-1aa6-4971-ae25-df14a8f5cb28">
<img width=15% src="https://github.com/user-attachments/assets/afc2e6ea-e7f1-423d-827a-bf6db731e2c5">
<img width=15% src="https://github.com/user-attachments/assets/1759fafe-f9f0-494f-b3b2-8cc7eb2e9104">
<img width=15% src="https://github.com/user-attachments/assets/9aa1fb57-ad67-431b-ab4e-c4b9eb6f97cd">

</br>

## Stack & Libraries

- React
- TypeScript
- Scss
- Tanstack-Query
- Zustand
- Storybook
- Vite
- Yarn berry

</br>

## Contributors

| [sikkzz](https://github.com/sikkzz) | [lgrin-byte](https://github.com/lgrin-byte) |
| :----------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------: |
| <img src="https://avatars.githubusercontent.com/u/100590110?s=400&u=6e0106f23a731e32bdc419191a2c6db649258055&v=4" width="180"> | <img src="https://avatars.githubusercontent.com/u/66896175?v=4" width="180"> |
| JunSik Kim | KyungRin Lee |

</br>

## Other Repositories

| Part | Repository |
| ---- | ------------------------------------------------ |
| iOS | [Link](https://github.com/Nexters/misik-ios) |
| AOS | [Link](https://github.com/Nexters/misik-android) |
| BE | [Link](https://github.com/Nexters/misik-api) |

</br>

## Development Collaboration Rules

### 이슈 생성 규칙

- 이슈는 이슈 템플릿에 맞춰 작성합니다.
- 기능 구현은 Feature 템플릿을 사용합니다.
- 버그 수정은 Bug 템플릿을 사용합니다.
- 이슈 제목은 [이슈 종류] 이슈 제목 형식으로 작성합니다.
- 예시
- [Feature] 프로젝트 초기 설정
- [Bug] 버튼 렌더링 조건 설정

### 브랜치 이름 규칙

- 브랜치 이름은 이슈 번호와 종류를 조합하여 작성합니다.
- 기능 구현은 feat을 버그 수정은 fix를 사용합니다.
- 예시
- 이슈번호 1번 기능 구현 → feat/#1
- 이슈번호 2번 버그 수정 → fix/#2

### 커밋 메시지 규칙

- 커밋 메시지는 한글로 작성하고 prefix는 다음과 같이 사용합니다.
- feat: 새로운 기능 추가
- fix: 버그 수정
- refactor: 기능 변경 없는 코드 수정
- chore: 개발 이외의 작업
- test: 테스트 코드 작성
- 예시
- feat: Button 컴포넌트 추가
- fix: Button 컴포넌트 렌더링 조건 수정
- refactor: Button 컴포넌트 import 순서 변경

### PR 작성 규칙

- PR 제목은 [이슈 종류/#이슈번호] PR 제목 형식으로 작성하고 본문은 템플릿에 맞춰 작성합니다.
- 예시
- [feat/#1] 프로젝트 초기 설정
- [fix/#3] 버튼 렌더링 조건 수정