Skip to content

Commit

Permalink
docs: edit
Browse files Browse the repository at this point in the history
  • Loading branch information
Minuooooo authored Dec 2, 2024
1 parent 687d26e commit 1103e21
Showing 1 changed file with 22 additions and 61 deletions.
83 changes: 22 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,33 @@
## 개발 환경
|분류|내용|
|:---|:---|
|Java version|11.0.20-amzn|
|Database|MySQL|
|Framework|Spring-boot '2.7.13'|
|빌드 관리 도구|Gradle|
|패키지 구조|DDD|
|배포|Docker, AWS-EC2|
|CI/CD|GitHub Actions|
|기타|AWS-RDS, AWS-S3|
|개발 Tool|IntelliJ|
|협업 Tool|GitHub, Notion, Figma, Discord|

<br></br>

## System Architecture
## 시스템 아키텍처
<img width="510" alt="System Architecture" src="https://github.com/user-attachments/assets/41bb5aa2-3922-4a73-b770-4c4f5dc1f53d">

<br></br>

## ERD
<img width="1192" alt="erd" src="https://github.com/user-attachments/assets/3ca2dbff-5501-43f9-bfa9-f223526aa5d7">


<br></br>

## API 명세서
[Docs](https://secret-enquiry-5de.notion.site/API-9fb86b9227b24311a6b9dcd6bba31bcc?pvs=4)

<br></br>

## Backend Convention
## 컨벤션
### Issues
`Ex. Title`

- 기능 개발, 오류 수정 등의 Issue 생성
- Issue number 확인 (#1, 2, 3..)
- 트러블 슈팅을 위해 오류에 대한 Issue를 생성하고, 해결 과정 문서화

<br></br>
- 기능 개발, 오류 수정 등의 이슈 생성
- 이슈 번호 확인
- 트러블 슈팅 기록

### Branch
`Ex. Type/#Issue.number-Title`

- `master` : 최종본
- `env` : 환경 설정
- `feat` : 이슈 별 기능 개발
- `refactor` : 리팩토링
- `fix` : 오류 수정
- `test` : 테스트 코드 작성

<br></br>

### Commit Message
`Ex. [ Type ] Title`

- `env` : 환경 설정
- `feat` : 기능 개발
- `refactor` : 리팩토링
- `fix` : 오류 수정
- `chore` : Gradle 설정, 기타 작업
- `test` : 테스트 코드 작성

<br></br>
-Type/#Issue.number-Title
- master: 최종본
- env: 환경 설정
- feat: 이슈 별 기능 개발
- refactor: 리팩토링
- fix: 오류 수정
- test: 테스트 코드 작성

### Commit
-[Type] Title
- env: 설정
- feat: 기능 개발
- refactor: 리팩토링
- fix: 오류 수정
- chore: gradle 설정, 기타 작업
- test: 테스트 코드

### PR
`Ex. [#Issue.number] Type: Title`

-[#Issue.number] Type: Title
<br></br>

## 😁 Team
Expand Down

0 comments on commit 1103e21

Please sign in to comment.