diff --git a/README.md b/README.md new file mode 100644 index 00000000..0f9d112f --- /dev/null +++ b/README.md @@ -0,0 +1,148 @@ +
+ +NotFound + + +## 세상 모든 반려동물을 한 자리에서! 왈왈🐶 + +반려동물과 일상의 추억을 기억하고 싶으신 적 없으신가요?
+왈왈은 반려동물과 함께할 수 있는 소소한 미션을 통해 추억을 기록하고, 다른 반려동물의 일상을 발견할 수 있는 +펫 커뮤니티 서비스입니다 + +
+ + + App Store + + + Instagram + +
+ + 서비스 소개 + + + 개발 로그 + + + 메이커 로그 + + +
+ +
+ +## ✨ IA(Information Architecture) + + + +
+ +--- + +## 📌 Package Architecture +왈왈 서버 패키지 아키텍처는 레이어드 아키텍처로 구성하였습니다.
+위 소개한 IA에서 큰 규모의 기능이 정의되지 않아, 당장은 클린 아키텍처 또는 헥사고날 아키텍처의 도입이 필요하지 않다고 판단하였습니다. +
+ +``` +// 프로젝트 전체 구조 +├── src.main.java.com.depromeet.stonebed +│ ├── domain +│ ├── global +│ ├── infra + +// domain 패키지는 비즈니스 로직을 담당하며 레이어드 아키텍처 구성 +│ ├── domain +│ └── auth +│ └── common +│ └── fcm +│ └── feed +│ └── follow +│ └── image +│ └── member +│ └── mission +│ └── missionHistory +│ └── missionRecordBoost +│ └── sqs + +// global 패키지는 전역 설정 담당 +│ ├── global +│ └── annotation +│ └── config +│ └── common +│ └── error +│ └── filter +│ └── interceptor +│ └── security +│ └── util + +// infra는 외부 연동 및 클라우드 구성 담당 +│ ├── infra +│ └── config +│ └── properties +// ... +``` + +
+ +--- + +## 💻 Tech Stack + + +
+ +--- + +## 🏛️ System Architecture + + +### 📦 CI/CD +- Github Actions +- Docker Hub +- Docker compose + +--- + +## 🖥️ Monitoring +모니터링은 Prometheus를 사용하여 서버의 상태에 대한 메트릭 수집과, Grafana를 사용하여 대시보드를 구성하였고,
+Loki, Promtail을 사용하여 로그 수집 및 저장을 구성하였습니다.
+또한, MySQL에 대한 SlowQuery 발생 시 Slack Webhook을 통한 알림 전송을 Lambda 함수로 작성하여 구성하였습니다.
+ + +--- + +
+ +

🧑‍💻 Server Developer

+
+ + + + + + + + + + + + + + + + + +
차윤범노관옥박윤찬
___
Server (Leader)ServerServer
+ +
+ +
+ + +
+ +
+ +### diff --git a/images/IA.png b/images/IA.png new file mode 100644 index 00000000..f8303aa0 Binary files /dev/null and b/images/IA.png differ diff --git a/images/app_qr.png b/images/app_qr.png new file mode 100644 index 00000000..42df3200 Binary files /dev/null and b/images/app_qr.png differ diff --git a/images/cloud-architecture.png b/images/cloud-architecture.png new file mode 100644 index 00000000..5e096f80 Binary files /dev/null and b/images/cloud-architecture.png differ diff --git a/images/intro.png b/images/intro.png new file mode 100644 index 00000000..a6672e51 Binary files /dev/null and b/images/intro.png differ diff --git a/images/introduction.png b/images/introduction.png new file mode 100644 index 00000000..7e136794 Binary files /dev/null and b/images/introduction.png differ diff --git a/images/tech-stack.png b/images/tech-stack.png new file mode 100644 index 00000000..e6ee2169 Binary files /dev/null and b/images/tech-stack.png differ