Skip to content

Latest commit

 

History

History
145 lines (111 loc) · 4.18 KB

README.md

File metadata and controls

145 lines (111 loc) · 4.18 KB
Raw

💰 Pennyway

지출 관리 SNS 플랫폼

Version # Revision Date Description Author
v0.0.1 2024.03.07 프로젝트 기본 설명 작성 양재서
v0.0.2 2024.03.29 ERD 추가, 라이브러리 버전 수정, Infra 추가 양재서
v0.0.3 2024.04.05 ERD 수정, 기술 스택 추가, Infra 및 아키텍처 추가/수정 양재서

👪 Backend Team

양재서 이진우 안성윤

🌳 Branch Convention

💡 Git-Flow 전략을 사용합니다.

  • main
    • 배포 가능한 상태의 코드만을 관리하는 프로덕션용 브랜치
    • PM(양재서)의 승인 후 병합 가능
  • dev
    • 개발 전용 브랜치
    • 한 명 이상의 팀원의 승인 후 병합 가능
    • 기능 개발이 완료된 브랜치를 병합하여 테스트를 진행
  • 이슈 기반 브랜치
    • 이슈는 {티켓번호}-{브랜치명}을 포함한다.
    • feat/{티켓번호}-{브랜치명}: 신규 기능 개발 시 브랜치명
    • fix/{티켓번호}-{브랜치명}: 리팩토링, 수정 작업 시 브랜치명
    • hotfix/{티켓번호}-{브랜치명}: 빠르게 수정해야 하는 버그 조치 시 브랜치명

🤝 Commit Convention

💡 angular commit convention

  • release: 배포 버전 업데이트 (major)
  • feat: 신규 기능 추가 (minor)
  • refactor: 코드 리팩토링 (minor)
  • fix: 버그 수정 (patch)
  • docs: 문서 수정 (patch)
  • rename: 주석, 로그, 변수명 등 수정 (patch)
  • style: 코드 포맷팅, 세미콜론 누락 (코드 변경 없는 경우) (patch)
  • test: 테스트 코드, 리펙토링 테스트 코드 추가 (patch)
  • chore: 빌드 업무 수정, 패키지 매니저 수정 (patch)

📌 Architecture

1️⃣ System Architecture

2️⃣ Infrastructure Architecture

3️⃣ Multi Module Architecture

4️⃣ ERD


📗 Tech Stack

1️⃣ Framework & Library

  • JDK 17
  • SpringBoot 3.2.3
  • Spring Boot Starter Security 3.2.4
  • Spring Data JPA 3.2.3
  • Spring Data Redis
  • Spring Boot Redisson 3.30.0
  • QueryDsl 5.0.0
  • Spring Doc Open API 2.4.0
  • Lombok 1.18.30
  • JUnit 5
  • testcontainers 1.19.7
  • jjwt 0.12.5
  • httpclient5 5.2.25.RELEASE
  • OpenFeign 4.0.6

2️⃣ Build Tools

  • Gradle 7.6.4

3️⃣ Database

  • MySQL 8
  • Redis 7.2.4

4️⃣ Infra

  • AWS EC2 (for Build Server, Bastion Server)
  • AWS NAT Gateway
  • AWS S3
  • AWS Route53
  • AWS VPC
  • AWS Elastic Load Balancer
  • AWS SNS
  • Docker & Docker-compose
  • Ngnix
  • GitHub Actions