Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 8.15 KB

README.md

File metadata and controls

108 lines (81 loc) · 8.15 KB
Raw

header

프로젝트 💙 이곳저곳 💙 BE Team의 Repository 입니다 💨

FE Repository는 👈 여기로

프로젝트 개요

⌛️ 프로젝트 기간

2022/07/18(月) ~ 2022/08/15(月)

🍳 팀원 소개

Kevin Kate Charlie Frank Kid
Product Owner Scrum Master Developer Developer Developer

🛠 프로젝트 구조

    ┌─────────────────────┐            
    ├─────────────────────┤  Request!  ┌───────────────┐           ┌──────────────┐        
    │                     ├───────────>│    Route 53   │           │    GitHub    │
    │      Front-end      │<───────────┤     (DNS)     │           └──────┬───────┘ 
    │                     │  Response! └─────┬───┬─────┘                  │ Push!
    └─────────────────────┘                  │   │                        │
                                       ┌─────┴───┴─────┐           ┌──────┴───────┐
    ┌───── Data Store ────┐            │ Application   │           │    Jenkis    │
    │   ┌──── RDS ────┐   │            │ Load Balancer │           │   (CI / CD)  │
    │   │    MySQL    │   │            └─────┬───┬─────┘           └────┬────┬────┘    
    │   └─────────────┘   │                  │   │                      │    │ Upload!
    │   ┌──── EC2 ────┐   │  Response! ┌─────┴───┴─────┐       Deploy!  │    └──────────────┐
    │   │    Redis    │   ├───────────>│  Spring Boot  │      ┌─────────┴─────┐      ┌──────┴──────┐
    │   └─────────────┘   │            │  Application  │<─────┤  Code Deploy  │<─────┤  S3 Bucket  │
    │   ┌──── S3 ─────┐   │<───────────┤     (EC2)     │      └───────────────┘      └─────────────┘
    │   │   Images    │   │  Request!  └───────────────┘
    │   └─────────────┘   │ 
    └─────────────────────┘

🔧 사용 기술

Java SpringBoot SpringDataJPA Querydsl SpringSecurity

🧱 인프라

Gradle MySQL AmazonAWS AmazonAWS AmazonAWS

📠 협업툴

GitHub Jira Notion Slack

프로젝트 진행

Branch Convention

현재 보호되고 있는 브랜치는 develop과 main 이며, develop은 개발용 main은 배포용입니다.

브랜치는 다음과 같이 명명합니다.

  • 기능 개발 목적의 브랜치
    • feature/Jira-이슈번호
  • 브랜치에서 발생한 버그 수정 목적의 브랜치
    • hotfix/Jira-이슈번호

PR Convention

  • [Jira 이슈번호] 간략한 제목 으로 PR 제목을 기재합니다.
  • merge는 2명 이상의 approve가 필요합니다.

Commit Convention

feat : 새로운 기능에 대한 커밋
fix : 버그 수정에 대한 커밋
chore : 빌드 업무 수정, 패키지 매니저 수정
docs : 문서 수정에 대한 커밋
style : 코드 스타일 혹은 포맷 등에 관한 커밋
refactor :  코드 리팩토링에 대한 커밋
test : 테스트 코드 수정에 대한 커밋

Code Convention

  • 코드 스타일
    • google code style
  • 접근제한자에 따른 코드 작성 순서
    • 필드: public -> private
    • 메서드: public -> private
    • 생성자: private -> public
  • 어노테이션에 따른 코드 작성 순서
    • DB 관련 어노테이션 (ex: Entity, Table)
    • 객체 관련 어노테이션 (ex: Getter, ToString)
    • 생성 관련 어노테이션 (ex: Builder, RequiredArgsConstructor)