diff --git a/README.md b/README.md index c93a0d8..1bf86d3 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -업데이트 예정 +## 🐰 Rabbit Chat +> 채팅 애플리케이션 + +![main_page](./doc/image/main_page.png) + + +## 🌳 Branch Convention +> 💡 Custom 전략을 사용합니다. + +- `main` : 배포 브랜치 +- `dev` : 개발 브랜치 +- 이슈 기반 브랜치 + - `feat/*` : 새로운 기능 개발 + - `refactor/*` : 기존 기능 개선 + - `fix/*` : 버그 수정 + - `chore/*` : 기타 작업 (예: 문서 수정, 코드 개선) + +## 📌 Architecture +### 1️⃣ System Architecture +![system_architecture](./doc/image/system_architecture.png) + +### 2️⃣ Infrastructure Architecture +![infrastructure_architecture](./doc/image/infrastructure.png) + +### 3️⃣ ERD +![erd](./doc/image/erd.png) diff --git a/doc/image/erd.png b/doc/image/erd.png new file mode 100644 index 0000000..b544cd3 Binary files /dev/null and b/doc/image/erd.png differ diff --git a/doc/image/infrastructure.png b/doc/image/infrastructure.png new file mode 100644 index 0000000..1ebd9a3 Binary files /dev/null and b/doc/image/infrastructure.png differ diff --git a/doc/image/main_page.png b/doc/image/main_page.png new file mode 100644 index 0000000..1209448 Binary files /dev/null and b/doc/image/main_page.png differ diff --git a/doc/image/system_architecture.png b/doc/image/system_architecture.png new file mode 100644 index 0000000..ca618ab Binary files /dev/null and b/doc/image/system_architecture.png differ