Skip to content

Commit 64a3c74

Browse files
authored
Create README.md
1 parent 94069f0 commit 64a3c74

1 file changed

Lines changed: 116 additions & 0 deletions

File tree

README.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<img width="1424" height="797" alt="image" src="https://github.com/user-attachments/assets/94621319-511d-4c20-b8cf-886faddcad59" />
2+
3+
<br/>
4+
<br/>
5+
6+
> 코밋은 사용자(의뢰인)와 작가(아티스트)를 연결하여 커미션을 의뢰·진행할 수 있는 플랫폼 애플리케이션입니다. </br>
7+
> 작품 등록, 채팅, 결제, 후기, 알림, 북마크 등 커미션 거래 전 과정을 지원합니다.
8+
9+
<br/>
10+
<br/>
11+
12+
# Tech Stack
13+
<div align=center>
14+
<div align=center>
15+
<img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black">
16+
<img src="https://img.shields.io/badge/node.js-339933?style=for-the-badge&logo=node.js&logoColor=white">
17+
<img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white">
18+
<img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white">
19+
<br>
20+
<img src="https://img.shields.io/badge/nginx-009639?style=for-the-badge&logo=nginx&logoColor=white">
21+
<img src="https://img.shields.io/badge/socket.io-010101?style=for-the-badge&logo=socket.io&logoColor=white">
22+
<img src="https://img.shields.io/badge/AWS%20EC2-FF9900?style=for-the-badge&logo=amazonec2&logoColor=white">
23+
<img src="https://img.shields.io/badge/AWS%20S3-569A31?style=for-the-badge&logo=amazons3&logoColor=white">
24+
<img src="https://img.shields.io/badge/AWS%20RDS-527FFF?style=for-the-badge&logo=amazonrds&logoColor=white">
25+
</div>
26+
<br>
27+
</div>
28+
29+
<br/>
30+
<br/>
31+
<br/>
32+
33+
# Server architecture
34+
<img width="873" height="731" alt="KakaoTalk_20250814_015717857" src="https://github.com/user-attachments/assets/78bb13ba-124c-42cb-942e-2f8a61225676" />
35+
36+
<br/>
37+
<br/>
38+
<br/>
39+
40+
41+
# Project Structure
42+
```plaintext
43+
├── .github
44+
│ ├── ISSUE_TEMPLATE
45+
│ └── workflows
46+
│ └── pull_request_template.md
47+
├── .idea
48+
├── .vscode
49+
├── config
50+
├── node_modules
51+
├── prisma
52+
├── public
53+
├── src
54+
│ ├── bookmark
55+
│ ├── chat
56+
│ ├── commission
57+
│ ├── common
58+
│ │ ├── errors
59+
│ │ └── swagger
60+
│ ├── home
61+
│ ├── middlewares
62+
│ ├── notification
63+
│ ├── payment
64+
│ ├── point
65+
│ ├── request
66+
│ ├── review
67+
│ ├── search
68+
│ └── user
69+
│ ├── auth.config.js
70+
│ ├── bigintJson.js
71+
│ ├── db.config.js
72+
│ ├── firebase.config.js
73+
│ ├── index.js
74+
│ ├── jwt.config.js
75+
│ ├── routes.js
76+
│ └── s3.upload.js
77+
├── views
78+
├── .gitignore
79+
├── Dockerfile
80+
├── eslint.config.js
81+
├── package-lock.json
82+
└── package.json
83+
```
84+
85+
<br/>
86+
<br/>
87+
88+
# Development Workflow
89+
## Branch Strategy
90+
**🪴 GitHub Flow** 기반
91+
92+
- `main`: 실제 배포용 브랜치, 항상 배포 가능한 상태를 유지
93+
- `develop` : 개발용 브랜치
94+
- `feat/{description}`: 기능 구현용 브랜치
95+
96+
## Commit Convention
97+
| 태그 | 설명 |
98+
| --- | --- |
99+
| `FEAT` | 새로운 기능 추가 |
100+
| `FIX` | 버그 및 오류 수정 |
101+
| `CHORE` | 자잘한 수정 |
102+
| `REFACTOR` | 리팩토링, 코드 구조 개선 |
103+
| `DOCS` | README.md 등 문서 수정 |
104+
| `TEST` | 테스트 코드 작성 |
105+
106+
<br/>
107+
<br/>
108+
109+
110+
# Team Members
111+
| 위지수 | 박지혜 | 배건우 | 서태영 |
112+
|:------:|:------:|:------:|:------:|
113+
| <img src="https://avatars.githubusercontent.com/weejee12" alt="위지수" width="150"> | <img src="https://avatars.githubusercontent.com/modzivv" alt="박지혜" width="150"> | <img src="https://avatars.githubusercontent.com/bkw535" alt="배건우" width="150"> | <img src="https://avatars.githubusercontent.com/taeyoung0524" alt="서태영" width="150"> |
114+
| BE | BE | BE | BE |
115+
| [GitHub](https://github.com/weejee12) | [GitHub](https://github.com/modzivv) | [GitHub](https://github.com/bkw535) | [GitHub](https://github.com/taeyoung0524) |
116+
|<li>홈/검색 기능<li>커미션 기능<li>신청함 기능 | <li>리뷰 기능<li>알림 기능|<li>서버 배포<li>채팅 기능<li>포인트/결제 기능|<li>로그인/회원가입<li>사용자 기능|<li>홈/검색 기능<li>커미션 기능<li>신청함 기능

0 commit comments

Comments
 (0)