README.md

HobbyTalk

동아리 가입, 좋아하는 취미에 대한 정보를 공유하는 오픈채팅 서비스입니다.

목차

• 개발환경
• 프로젝트 목표
• 어플리케이션 구조도
• API doc
• ERD
• 어플리케이션 아키텍처
• Git 브랜치 전략
• PR 리뷰 규칙

개발환경

• 언어/프레임워크

  Java 17 / SpringBoot 3.15 / Gradle 7.6

• 데이터베이스

  MySQL 8.* (Source, Replica) / Redis (Cache, Pub/Sub) / Mybatis / Hikari

• 인증 / 인가

  JWT / Bcrypt

• 통신 프로토콜

  HTTP 1.1 / WebSocket

프로젝트 목표

• 실시간 통신 및 대용량 트래픽을 받아들일수 있는 튼튼한 어플리케이션을 만드는것
• scale-out 할수있는 분산서버를 고려한 확장성 있는 어플리케이션을 만드는것
• 객체지향 설계원칙에 따른 가독성 및 유지보수성을 고려한 좋은 코드를 짜는것
• 지속적인 리팩토링으로 가독성을 챙기면서 유지보수할것
• 안전한 리팩토링을 위해 테스트코드를 작성하며 추후에는 TDD를 적용해보는것

어플리케이션 구조도

API doc

API 명세서 링크 <<

ERD

어플리케이션 아키텍처

Git 브랜치 전략 (Github-Flow)

1. 모든 브랜치는 Main 브랜치에서 파생됩니다.

2. 모든 브랜치는 PR리뷰 작성 후 Main에 merge 합니다.

PR 리뷰 규칙

1. PR리뷰에는 하나 이상의 코멘트를 달아야 한다.

2. PR리뷰에 변경된 소스코드에는 테스트코드를 포함해야 한다.