From 4437b6cc1129ee119717bebb472265ab89c8aef7 Mon Sep 17 00:00:00 2001 From: sikkzz Date: Mon, 24 Feb 2025 22:45:10 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20readme.md,=20LICENSE,=20code=20owners?= =?UTF-8?q?=20=EC=97=85=EB=8D=B0=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/CODEOWNERS | 2 +- LICENSE | 21 +++++++++++ README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 114 insertions(+), 2 deletions(-) create mode 100644 LICENSE diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 083503a..66e0ed9 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @sikkzz @lgrin-byte \ No newline at end of file +* @sikkzz \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d3ac517 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index dfecab9..16431e4 100644 --- a/README.md +++ b/README.md @@ -1 +1,92 @@ -# misik-web +# 영수증 리뷰를 AI로 더 쉽고 즐겁게 Misik + +영수증을 촬영하면 AI가 자동으로 맛집 리뷰를 생성해줘요! 🍽️ + +| Type | Link | +| ------------- | --------------------------------------------------------------- | +| 플레이 스토어 | https://play.google.com/store/apps/details?id=com.nexters.misik | +| 앱 스토어 | | + +
+ +## Screenshots + + + + + + + +
+ +## Stack & Libraries + +- React +- TypeScript +- Scss +- Tanstack-Query +- Zustand +- Storybook +- Vite +- Yarn berry + +
+ +## Contributors + +| [sikkzz](https://github.com/sikkzz) | [lgrin-byte](https://github.com/lgrin-byte) | +| :----------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------: | +| | | +| JunSik Kim | KyungRin Lee | + +
+ +## 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) | + +
+ +## 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] 버튼 렌더링 조건 수정