Skip to content

2025-All4Land-RideOn/BE

Repository files navigation

🚴‍♂️ BE - RideOn

RideOn BE 레포지토리입니다.

1. 📂 Folder Structure

rideon/
├── .github/                          # GitHub 관련 설정
│   ├── ISSUE_TEMPLATE/               # 이슈 템플릿
│   ├── workflows/                    # GitHub Actions CI/CD
│   └── pull_request_template.md      # PR 템플릿
│
├── backend/                          # Spring Boot + Gradle 프로젝트
│   ├── src/main/java/com/sessakbori/rideon
│   │   ├── domain/                   # 도메인별 디렉토리 (Member, Station, Rental 등)
│   │   │   ├── controller/           # API 컨트롤러
│   │   │   ├── service/              # 비즈니스 로직
│   │   │   ├── repository/           # JPA Repository
│   │   │   ├── dto/                  # 요청/응답 DTO
│   │   │   └── entity/               # DB 엔티티
│   │   ├── global/                   # 공통 모듈
│   │   │   ├── config/               # 설정 클래스 (DB, Swagger, Security 등)
│   │   │   ├── exception/            # 예외 처리 (CustomException, GlobalHandler)
│   │   │   ├── response/             # 공통 응답 객체 (ApiResponse 등)
│   │   │   └── utils/                # 유틸리티 클래스
│   │   └── RideonApplication.java    # 메인 실행 클래스
│   │
│   └── src/main/resources/
│       ├── application.yml           # 환경 설정
│       └── static/                   # 정적 리소스
│
├── .gitignore                        # Git ignore 규칙
└── README.md                         # 프로젝트 가이드

2. 🌿 Branch Strategy & Naming Convention

브랜치 전략은 Git Flow를 단순화한 구조로, main은 배포용 안정 브랜치, develop은 통합 브랜치로 사용합니다.
기능·수정·작업 단위(feature/*, refactor/* 등)의 브랜치는 develop에서 분기합니다.

머릿말 설명 예시
main 운영 브랜치 main
develop 개발 브랜치 develop
feat 기능 구현 feat/#60-login-page
refactor 리팩토링 refactor/#12-member-service
fix 버그 수정 fix/#34-login-bug
hotfix 긴급 수정 hotfix/#99-db-connection
infra 인프라 작업 infra/#45-dockerfile
remove 불필요 코드/파일 삭제 remove/#77-unused-component

3. 📝 Commit Convention

머릿말 설명 예시
feat 기능 추가 feat: 로그인 페이지 구현
refactor 리팩토링 refactor: MemberService 로직 최적화
fix 버그 수정 fix: 헤더 네비게이션 오류 수정
hotfix 긴급 수정 hotfix: DB 커넥션 풀 문제 해결
docs 문서 수정 docs: README 브랜치 전략 섹션 추가
chore 설정/환경 작업 chore: ESLint 및 Prettier 설정 추가
comment 주석 추가 comment: 서비스 로직 설명 주석 추가
remove 삭제 remove: 사용하지 않는 컴포넌트 삭제

4. 🔀 Pull Request Convention

  • PR 제목: {label}: {내용}
    • 예) feat: 대여소 지도 페이지 구현
  • 내용: 작업 요약, 테스트 방법, 참고사항
  • Reviewer: 팀 전원(본인 제외)
  • Label: feat / fix / refactor 등

5. 🛠 Workflow

단계 설명
1 이슈 생성
2 브랜치 생성 (prefix/#이슈번호-작업명) → develop 기준
3 작업 후 커밋
4 Pull Request 생성 → 코드 리뷰
5 리뷰 승인 후 develop 에 머지

6. 📘 API 문서

API 문서

7. 🗂️ ERD

[추후 추가 예정]

8. 🖥️ 시스템 아키텍처

[추후 추가 예정]

About

RideOn BE Repository

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5