https://github.com/depromeet/clog-server
클라이밍 기록 아카이빙 서비스 '클로그'의 백엔드 레포지토리입니다.
https://github.com/depromeet/clog-server
Last synced: 27 days ago
JSON representation
클라이밍 기록 아카이빙 서비스 '클로그'의 백엔드 레포지토리입니다.
- Host: GitHub
- URL: https://github.com/depromeet/clog-server
- Owner: depromeet
- Created: 2025-01-31T13:47:08.000Z (8 months ago)
- Default Branch: develop
- Last Pushed: 2025-03-17T13:26:09.000Z (7 months ago)
- Last Synced: 2025-03-17T14:35:53.588Z (7 months ago)
- Language: Kotlin
- Homepage:
- Size: 5.61 MB
- Stars: 7
- Watchers: 0
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## 🙌 Hello
**클로그 Server 팀**은 클라이밍 기록을 쉽고 편리하게 관리할 수 있는 서비스, **클로그**의 백엔드를 개발 및 운영합니다.
안정적인 서비스 제공을 위해 시스템 설계, 개발, 배포, 모니터링 전반을 책임지고 있습니다.
## 🧩 Tech Stack
| 구분 | 기술 |
|------|------|
| **Language** | Kotlin |
| **Framework** | Spring Boot |
| **Database** | MySQL |
| **Infra** | NCP, S3 |
| **CI / CD** | GitHub Actions, Kubernetes, ArgoCD |
| **Monitoring** | Elastic APM, Kibana |
## Project Setting
### detekt
```bash
git config core.hooksPath .githooks
chmod +x .githooks/pre-commit
```
## 🏛️ System Architecture
- 서비스는 Naver Cloud Platform (NCP) 기반에서 운영되며, Kubernetes 환경에서 배포 및 관리됩니다.
- CI/CD 파이프라인은 GitHub Actions와 ArgoCD를 통해 자동화되어 있습니다.
- 서비스 모니터링은 Elastic Stack을 활용하여 로그 수집, 분석, APM 트레이싱을 수행합니다.
## 🏗️ Application Architecture
- Domain-Driven Design (DDD) 기반으로 설계되었으며, 명확한 도메인 경계를 통해 유지보수성과 확장성을 확보했습니다.
- 멀티 모듈 구조로 구성되어 각 도메인의 관심사를 분리하고 독립적인 개발이 가능하도록 했습니다.
- 주요 모듈은 다음과 같습니다:
``` bash
📁 clog-backend/
├── clog-admin/ # 어드민 기능 제공 모듈
├── clog-api/ # 클라이언트 요청을 처리하는 API 모듈
├── clog-domain/ # 도메인 모델 정의 (Repository interface 등)
├── clog-infrastructure/ # 외부 API 연동, DB 연동 등의 구현체
├── clog-global-utils/ # 공통 유틸 등
```
## 🚨 Monitoring / Alert
> 다양한 지표와 로그를 효과적으로 수집하고 시각화하여 **서비스 가용성**과 **성능 최적화**에 기여합니다.
- 각 도구는 독립적이면서도 통합적으로 관리되어 **유연한 확장성**과 **효율적인 문제 진단**을 지원합니다.
- Elastic APM: 전체 요청 흐름 트레이싱 및 병목 탐지
- Logstash → Elasticsearch: 로그 수집 및 저장
- Kibana: 실시간 로그 및 성능 데이터 시각화
- 장애 탐지 및 이슈 발생 시 Slack 알림 연동 예정
## 🧑💻 Contribution
| 김대원 | 권기준 | 최혜미 |
|:---:|:---:|:---:|
| 
| 
| 
|
| **Server** (Lead) | **Server** | **Server** |
## 📎 기타 참고 자료
🔗 [API 명세서 (Swagger)](https://your-link-to-swagger.com)
🗂️ [시스템 다이어그램 (작성 예정)](https://your-link-to-system-diagram.com)
📝 [기술 블로그 포스팅 (작성 예정)](https://your-link-to-blog.com)