Skip to content

Commit 4437b6c

Browse files
committed
docs: readme.md, LICENSE, code owners 업데이트
1 parent 97bb80f commit 4437b6c

File tree

3 files changed

+114
-2
lines changed

3 files changed

+114
-2
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @sikkzz @lgrin-byte
1+
* @sikkzz

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Nexters
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 92 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,92 @@
1-
# misik-web
1+
# 영수증 리뷰를 AI로 더 쉽고 즐겁게 Misik
2+
3+
영수증을 촬영하면 AI가 자동으로 맛집 리뷰를 생성해줘요! 🍽️
4+
5+
| Type | Link |
6+
| ------------- | --------------------------------------------------------------- |
7+
| 플레이 스토어 | https://play.google.com/store/apps/details?id=com.nexters.misik |
8+
| 앱 스토어 | |
9+
10+
</br>
11+
12+
## Screenshots
13+
14+
<img width=30% src="https://github.com/user-attachments/assets/6be8235f-80fa-484b-9678-0f791b1d8fe1">
15+
<img width=15% src="https://github.com/user-attachments/assets/e696eedc-1aa6-4971-ae25-df14a8f5cb28">
16+
<img width=15% src="https://github.com/user-attachments/assets/afc2e6ea-e7f1-423d-827a-bf6db731e2c5">
17+
<img width=15% src="https://github.com/user-attachments/assets/1759fafe-f9f0-494f-b3b2-8cc7eb2e9104">
18+
<img width=15% src="https://github.com/user-attachments/assets/9aa1fb57-ad67-431b-ab4e-c4b9eb6f97cd">
19+
20+
</br>
21+
22+
## Stack & Libraries
23+
24+
- React
25+
- TypeScript
26+
- Scss
27+
- Tanstack-Query
28+
- Zustand
29+
- Storybook
30+
- Vite
31+
- Yarn berry
32+
33+
</br>
34+
35+
## Contributors
36+
37+
| [sikkzz](https://github.com/sikkzz) | [lgrin-byte](https://github.com/lgrin-byte) |
38+
| :----------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------: |
39+
| <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"> |
40+
| JunSik Kim | KyungRin Lee |
41+
42+
</br>
43+
44+
## Other Repositories
45+
46+
| Part | Repository |
47+
| ---- | ------------------------------------------------ |
48+
| iOS | [Link](https://github.com/Nexters/misik-ios) |
49+
| AOS | [Link](https://github.com/Nexters/misik-android) |
50+
| BE | [Link](https://github.com/Nexters/misik-api) |
51+
52+
</br>
53+
54+
## Development Collaboration Rules
55+
56+
### 이슈 생성 규칙
57+
58+
- 이슈는 이슈 템플릿에 맞춰 작성합니다.
59+
- 기능 구현은 Feature 템플릿을 사용합니다.
60+
- 버그 수정은 Bug 템플릿을 사용합니다.
61+
- 이슈 제목은 [이슈 종류] 이슈 제목 형식으로 작성합니다.
62+
- 예시
63+
- [Feature] 프로젝트 초기 설정
64+
- [Bug] 버튼 렌더링 조건 설정
65+
66+
### 브랜치 이름 규칙
67+
68+
- 브랜치 이름은 이슈 번호와 종류를 조합하여 작성합니다.
69+
- 기능 구현은 feat을 버그 수정은 fix를 사용합니다.
70+
- 예시
71+
- 이슈번호 1번 기능 구현 → feat/#1
72+
- 이슈번호 2번 버그 수정 → fix/#2
73+
74+
### 커밋 메시지 규칙
75+
76+
- 커밋 메시지는 한글로 작성하고 prefix는 다음과 같이 사용합니다.
77+
- feat: 새로운 기능 추가
78+
- fix: 버그 수정
79+
- refactor: 기능 변경 없는 코드 수정
80+
- chore: 개발 이외의 작업
81+
- test: 테스트 코드 작성
82+
- 예시
83+
- feat: Button 컴포넌트 추가
84+
- fix: Button 컴포넌트 렌더링 조건 수정
85+
- refactor: Button 컴포넌트 import 순서 변경
86+
87+
### PR 작성 규칙
88+
89+
- PR 제목은 [이슈 종류/#이슈번호] PR 제목 형식으로 작성하고 본문은 템플릿에 맞춰 작성합니다.
90+
- 예시
91+
- [feat/#1] 프로젝트 초기 설정
92+
- [fix/#3] 버튼 렌더링 조건 수정

0 commit comments

Comments
 (0)