Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daeun084 authored Nov 20, 2024
1 parent 0074cea commit 17b2987
Showing 1 changed file with 38 additions and 14 deletions.
52 changes: 38 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<br>

## Member
## 👥 Member
| 김다은 | 오세연 |
| :------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------: |
| <img src="https://avatars.githubusercontent.com/u/122000839?v=4" width=90px alt="김다은"/> | <img src="https://avatars.githubusercontent.com/oosedus?v=4" width=90px alt="오세연"/> |
Expand All @@ -15,12 +15,7 @@
<br><br>


## Convention

#### Commit Convention
- **`ConventionType: 구현한 내용`**
- ex) feat: 회원가입 기능 구현 <br><br>

## 📐 Convention

#### Convention Type
| convention type | description |
Expand All @@ -35,36 +30,65 @@
| `refactor` | 코드 리팩토링 |
| `!hotfix` | develop 브랜치에 급하게 커밋해야 하는 경우 |

<br>
#### Commit
- **`ConventionType: 구현한 내용`**

#### Issue
- Issue Title : **`ConventionType: 작업할 내용`**
- 모든 작업은 `Issue`를 만든 후, 해당 이슈 번호에 대한 branch를 통해 수행
- 수행할 작업에 대한 설명과 할 일을 작성

<br>

#### Pull Request
- Pull Request Title : **`[ContentionType/#이슈번호] 작업한 내용`**
- 수행한 작업에 대한 설명을 작성하고 관련 스크린샷을 첨부
- Reviewer, Assigner, Label, Project, Milestone, 관련 이슈를 태그
- 작업 중 참고한 자료 혹은 reviewer에게 전할 내용이 있다면 하단에 작성

<br>

#### Branch
- Branch Name : **`컨벤션명/#이슈번호`**
- `Pull Request`를 통해 develop branch에 merge 후, 해당 branch 제거

<br><br>

## Architecture
## 🛠️ Stack
**Language & Framework**
<img src="https://img.shields.io/badge/Java-007396?style=flat&logo=Java&logoColor=white" />
<img src="https://img.shields.io/badge/Spring Boot-6DB33F?style=flat&logo=SpringBoot&logoColor=white" />
<img src="https://img.shields.io/badge/Spring Security-6DB33F?style=flat&logo=SpringSecurity&logoColor=white" />

**Documentation**
<img src="https://img.shields.io/badge/Swagger-85EA2D?style=flat&logo=Swagger&logoColor=black" />

**Database & ORM**
<img src="https://img.shields.io/badge/Spring Data JPA-6DB33F?style=flat&logo=Spring&logoColor=white" />
<img src="https://img.shields.io/badge/MySQL-4479A1?style=flat&logo=MySQL&logoColor=white" />

**Build Tool**
<img src="https://img.shields.io/badge/Gradle-02303A?style=flat&logo=Gradle&logoColor=white" />

**Cloud & Hosting**
<img src="https://img.shields.io/badge/AmazonEC2-FF9900?style=flat&logo=AmazonEC2&logoColor=white" />
<img src="https://img.shields.io/badge/AmazonRDS-527FFF?style=flat&logo=AmazonRDS&logoColor=white" />

**Containerization & CI/CD**
<img src="https://img.shields.io/badge/Docker-2496ED?style=flat&logo=Docker&logoColor=white" />
<img src="https://img.shields.io/badge/GithubActions-2088FF?style=flat&logo=GithubActions&logoColor=white" />

**Network & Security**
<img src="https://img.shields.io/badge/Nginx-009639?style=flat&logo=nginx&logoColor=white" />
<img src="https://img.shields.io/badge/AWS Load Balancer-FF9900?style=flat&logo=AmazonAWS&logoColor=white" />
<img src="https://img.shields.io/badge/AWS Certificate Manager-527FFF?style=flat&logo=AmazonAWS&logoColor=white" />

<br><br>


## 🏛️ Architecture
![MOAMOA_ARCHITECTURE](https://github.com/user-attachments/assets/d9aaee68-0793-482c-b57a-2f2ab4d56756)


<br><br>

## ERD
## 📊 ERD
![MOAMOA_ERD](https://github.com/user-attachments/assets/fdd8622b-8418-45e2-966a-9757fc5e8b7c)


Expand Down

0 comments on commit 17b2987

Please sign in to comment.