Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Star-mini authored Jul 16, 2024
1 parent e9909f4 commit 08b3354
Showing 1 changed file with 61 additions and 41 deletions.
102 changes: 61 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,61 @@
# 52panda-back
중고 경매 사이트 백엔드 서버입니다.

## Commit Convention
- feat : 새로운 기능 추가
- fix : 버그 수정
- docs : 문서 수정
- style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
- refactor: 코드 리펙토링
- test: 테스트 코드, 리펙토링 테스트 코드 추가
- chore : 빌드 업무 수정, 패키지 매니저 수정

## 💡 PR Convetion

| 아이콘 | 코드 | 설명 |
| ------ | -------------------------- | ------------------------ |
| 🎨 | :art | 코드의 구조/형태 개선 |
| ⚡️ | :zap | 성능 개선 |
| 🔥 | :fire | 코드/파일 삭제 |
| 🐛 | :bug | 버그 수정 |
| 🚑 | :ambulance | 긴급 수정 |
|| :sparkles | 새 기능 |
| 💄 | :lipstick | UI/스타일 파일 추가/수정 |
|| :rewind | 변경 내용 되돌리기 |
| 🔀 | :twisted_rightwards_arrows | 브랜치 합병 |
| 💡 | :bulb | 주석 추가/수정 |
| 🗃 | :card_file_box | 데이버베이스 관련 수정 |

## Code Convention

- 기본 : 카멜 표기법
- 전역 변수 : 어퍼케이스 표기법
- 지역 변수 : 카멜 표기
- Filter : Tab으로 들여쓰기 주의
- 함수 : 함수명 + 중괄호, 함수 하나가 끝날 시 한 줄 뛰고 다음 함수 기입
- 주석 : 함수 위에 해당 함수의 모든 주석 쓰기,
- 콤마(,) : ,기입후 한 칸 띄우고 다음 단어 기입
- 대입 연산자(=) : 단어 = 단어 식으로 기입
- 제어문(if) : 항상 중괄호 처리
- 문자열 : " "
- 단어: ' '
![image](https://github.com/user-attachments/assets/42a69bfd-13cb-4406-b7fe-a57207cb9653)


<br/>
<br/>
## :family_man_man_boy_boy: 팀원 소개

![image](https://github.com/user-attachments/assets/85b4ffaa-95b5-40c3-9bf3-2ba8f1cdb617)

<br/>
<br/>

## :page_with_curl: 프로젝트 개요

![image](https://github.com/user-attachments/assets/2c388dc1-b80e-4402-96fe-f409a0a8b5cf)


<br/>
<br/>


## :newspaper: 프로젝트 산출물

![image](https://github.com/user-attachments/assets/7514c154-5d13-4ddb-a7c6-a94ad23ba93a)

<br/>
<br/>

## :hammer_and_wrench: 기술 스택

![image](https://github.com/user-attachments/assets/77c1e009-9ef2-410b-9da5-42d40d3339ec)


<br/>
<br/>

## :gear: 프로젝트 구성

### CI/CD

![image](https://github.com/user-attachments/assets/7a1f9a9e-ba3e-4f08-8a2a-fb4a152c630e)

### 아키텍쳐

![image](https://github.com/user-attachments/assets/dd3f77a5-6d90-4e56-84cc-6ff992b5b24e)
![image](https://github.com/user-attachments/assets/cec5d342-67aa-4a0d-89ea-711f90b89ed2)


<br/>
<br/>

## :bulb: 주요 기능

![image](https://github.com/user-attachments/assets/2b63f5e1-33a0-4b7d-877d-83f4edf85184)



## :tv: 시연 영상

https://www.youtube.com/watch?v=S5RvQMaOAEU

0 comments on commit 08b3354

Please sign in to comment.