Skip to content

Latest commit

Β 

History

History
150 lines (122 loc) Β· 7.06 KB

README.md

File metadata and controls

150 lines (122 loc) Β· 7.06 KB

1️⃣ Contributors

Backend (Lead) Backend Backend
ht3064 alswjdghks iiqcov
μ΅œν˜„νƒœ λ―Όμ •ν™˜ μœ μ§€μ„ 

2️⃣ Project


3️⃣ Tech

πŸ“¦οΈ Dependency

- Gradle 8.7
- Java 17
- Spring Boot 3.2.5
- MySQL 8.0.33
- QueryDSL 5.0.0
- Swagger 2.2.0
- Spring Cloud 2023.0.0

πŸ›οΈ Architecture


πŸ› οΈ Tech Stack

Framework -

ORM -

Authorization -

Test -

Database -

CICD -

AWS -

Code Coverage -

Other -


πŸ” ERD


πŸ“ API Specification

❓ Notion API Specification


πŸ“‚ Directory Structure

src
β”œβ”€β”€ main
β”‚   β”œβ”€β”€ java
β”‚   β”‚   └── com
β”‚   β”‚       └── api
β”‚   β”‚           └── pickle  
β”‚   β”‚                β”œβ”€β”€ domain
β”‚   β”‚                β”‚   β”œβ”€β”€ album
β”‚   β”‚                β”‚   β”‚   β”œβ”€β”€ api
β”‚   β”‚                β”‚   β”‚   β”œβ”€β”€ application
β”‚   β”‚                β”‚   β”‚   β”œβ”€β”€ dao
β”‚   β”‚                β”‚   β”‚   β”œβ”€β”€ domain
β”‚   β”‚                β”‚   β”‚   └── dto
β”‚   β”‚                β”‚   β”œβ”€β”€ auth
β”‚   β”‚                β”‚   β”œβ”€β”€ bookmark
β”‚   β”‚                β”‚   β”œβ”€β”€ common
β”‚   β”‚                β”‚   β”œβ”€β”€ image
β”‚   β”‚                β”‚   β”œβ”€β”€ imagetag
β”‚   β”‚                β”‚   β”œβ”€β”€ member
β”‚   β”‚                β”‚   β”œβ”€β”€ membertag
β”‚   β”‚                β”‚   β”œβ”€β”€ participant
β”‚   β”‚                β”‚   β”œβ”€β”€ sharedalbum
β”‚   β”‚                β”‚   └── tag
β”‚   β”‚                β”œβ”€β”€ global
β”‚   β”‚                β”‚   β”œβ”€β”€ common
β”‚   β”‚                β”‚   β”‚    β”œβ”€β”€ constants
β”‚   β”‚                β”‚   β”‚    └── response
β”‚   β”‚                β”‚   └── config
β”‚   β”‚                β”‚   β”‚    β”œβ”€β”€ feign
β”‚   β”‚                β”‚   β”‚    β”œβ”€β”€ querydsl
β”‚   β”‚                β”‚   β”‚    β”œβ”€β”€ security
β”‚   β”‚                β”‚   β”‚    └── swagger
β”‚   β”‚                β”‚   β”œβ”€β”€ common
β”‚   β”‚                β”‚   β”‚    └── exception
β”‚   β”‚                β”‚   β”œβ”€β”€ security
β”‚   β”‚                β”‚   └── util
β”‚   β”‚                β”œβ”€β”€ infra
β”‚   β”‚                β”‚   β”œβ”€β”€ fastapi
β”‚   β”‚                β”‚   β”œβ”€β”€ fcm
β”‚   β”‚                β”‚   β”œβ”€β”€ feign
β”‚   β”‚                β”‚   β”œβ”€β”€ jwt
β”‚   β”‚                β”‚   β”œβ”€β”€ oauth
β”‚   β”‚                β”‚   β”œβ”€β”€ properties
β”‚   β”‚                β”‚   β”œβ”€β”€ redis
β”‚   β”‚                β”‚   └── s3
β”‚   └── resources
β”‚       β”œβ”€β”€ application.yml
β”‚       β”œβ”€β”€ application-dev.yml
β”‚       β”œβ”€β”€ application-prod.yml
β”‚       β”œβ”€β”€ application-redis.yml
β”‚       β”œβ”€β”€ application-s3.yml
β”‚       β”œβ”€β”€ application-fastapi.yml
β”‚       └── application-security.yml

4️⃣ Convention

🌳 Commit Convention

[prefix]/이슈번호-μ΄μŠˆλ‚΄μš©
prefix definition
feat μƒˆλ‘œμš΄ κΈ°λŠ₯을 μΆ”κ°€ν•  경우
fix κΈ°λŠ₯을 μˆ˜μ •ν•˜λŠ” 경우
chore ν”„λ‘œμ νŠΈλ₯Ό μ„€μ •ν•˜λŠ” 경우
bug κΈ°λŠ₯에 였λ₯˜κ°€ λ°œμƒν•˜μ—¬ μˆ˜μ •ν•˜λŠ” 경우
hotfix κΈ°λŠ₯ μˆ˜μ •μ„ κΈ΄κΈ‰ν•˜κ²Œ μ§„ν–‰ν•˜λŠ” 경우
refactor μ½”λ“œλ₯Ό λ¦¬νŒ©ν† λ§ ν•˜λŠ” 경우
docs ν”„λ‘œμ νŠΈ κ΄€λ ¨ λ¬Έμ„œ μž‘μ—…μ„ μ§„ν–‰ν•˜λŠ” 경우
test ν…ŒμŠ€νŠΈ μ½”λ“œλ₯Ό μž‘μ„±ν•˜λŠ” 경우

πŸ”– Branch Strategy

  • main : 배포 μ„œλ²„μ™€ μ—°κ²°λ˜λŠ” 브랜치
  • develop : 개발이 μ™„λ£Œλœ μ΅œμ‹  브랜치
  • feature : κΈ°λŠ₯ 개발이 각자 μ§„ν–‰λ˜λŠ” 브랜치
  • hotfix : 배포 μ„œλ²„μ—μ„œ λ°œμƒν•œ 버그λ₯Ό μˆ˜μ •ν•˜λŠ” 브랜치