Hype-BE

잘 알려지지 않은 숨은 명곡을 공유하고 대결과 투표를 통해 더 좋은 곡을 알아가는 서비스

🎼 즐겨 듣는 명곡 추천

즐겨 듣는 노래를 검색하고 글을 작성하여 다른 사용자들에게 추천할 수 있습니다.

🆚 다른 추천 곡과의 대결

다른 사용자가 추천한 노래에 대결을 신청하고 투표를 받을 수 있습니다.

💎 대결 결과와 유저 랭킹 확인

대결 종료 후 승패를 확인하고 승리 포인트를 얻을 수 있습니다. 포인트 기준으로 산정되는 주간 랭킹을 확인할 수 있습니다.

👀 다른 사용자의 추천 음악 따라 듣기

다른 사용자가 추천한 노래들을 확인할 수 있습니다.

Hype 서비스 바로가기

프로젝트 개요

내가 좋아하는 음악을 추천하고자 하는 욕구가 있는 사람들, 내가 아직 모르는 음악들을 추천받고 싶은 사람들을 대상으로 하는 음악 대결 서비스 입니다. 음악을 공유하는 사람들은 추천글을 쓰고 좋아요와 다른 노래와의 대결을 생성해 다른사람들의 반응을 확인할 수 있습니다. 노래를 추천받고 싶은 사람들은 다른사람이 제공하는 추천글, 이상형월드컵 형식으로 제공되는 음악 대결에 투표하는 것을 통해 게임처럼 자신이 모르던 장르의 노래를 새로 알게 될 수 있습니다.

🛠 Used Stacks

Java 17	Gradle	SpringBoot 2.7.7	Spring Data JPA	MySQL 8.0

👥 팀원

이수영	김소현	박세준
백엔드 개발	백엔드 개발	백엔드 개발

멘토	서브멘토
마르코	김명환

📏 Code Convention

Naver 코드 컨벤션 + CheckStyle 적용

🌴 Commit Convention

태그 이름	설명
[CHORE]	로직과 상관없는 잡다한 작업 ( resource 추가, yml 추가 등 )
[FIX]	코드 수정
[FEAT]	새로운 기능 구현
[ADD]	코드 추가
[HOTFIX]	급한 사항
[DEL]	코드 삭제
[DOCS]	README 등의 문서 개정
[REFACTOR]	파일 이름 변경, 구조 변경 등의 전면 수정
[TEST]	테스트 코드

✨ Branch Strategy

git 전략 - git flow 전략

• main : 초기 프로젝트 설정 브랜치
• develop : 개발(작업) 브랜치: 해당 브랜치로 push 할 경우 CD
• 이름_#이슈번호 : 이슈별 개발 브랜치
• 이름 : 개인 작업 브랜치

📃 API 명세서

API 명세서 Swagger

API 명세서 문서화 Wiki

API 명세서 초안 Nostion

🥫 ERD

🗂 프로젝트 폴더 구조

MVC 기반

📁 src
|_ 📁 main
|_ |_ 📁 common
|_ |_ 📁 config
|_ |_ 📁 constrant
|_ |_ 📁 controller
|_ |_ 📁 dto
|_ |_ 📁 exception
|_ |_ 📁 model
|_ |_ 📁 repository
|_ |_ 📁 services
|_ |_ 📁 util
|_ 📁 test

🌴 Dependencies Module

build.gradle

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
    implementation 'org.springframework.boot:spring-boot-starter-data-redis-reactive'
    implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
    implementation 'org.springframework.boot:spring-boot-starter-security'
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-validation'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.cloud:spring-cloud-starter:3.1.5'
    implementation 'org.flywaydb:flyway-core'
    implementation 'org.flywaydb:flyway-mysql'
    implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5'
    implementation 'io.jsonwebtoken:jjwt:0.9.1'
    implementation 'org.redisson:redisson-spring-boot-starter:3.18.0'

    testImplementation 'org.projectlombok:lombok:1.18.22'
    compileOnly 'org.projectlombok:lombok'
    developmentOnly 'org.springframework.boot:spring-boot-devtools'
    runtimeOnly 'com.h2database:h2'
    runtimeOnly 'com.mysql:mysql-connector-j'
    annotationProcessor 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"

    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'io.projectreactor:reactor-test'
    testImplementation 'org.springframework.security:spring-security-test'
    testImplementation 'org.testcontainers:junit-jupiter'
    testImplementation 'org.testcontainers:mysql'
    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
    testImplementation 'com.epages:restdocs-api-spec-mockmvc:0.16.4'
    testImplementation "org.junit.jupiter:junit-jupiter-params"
    testImplementation 'io.findify:s3mock_2.13:0.2.6'
    implementation 'com.google.guava:guava:31.1-jre'
    swaggerUI 'org.webjars:swagger-ui:4.1.3'

    implementation "ca.pjer:logback-awslogs-appender:1.6.0"
    implementation 'com.amazonaws:aws-java-sdk-bom:1.12.417'
    implementation 'com.amazonaws:aws-java-sdk-s3:1.12.410'
}

☘ environment variables

/localTestDB/db_info.env

MYSQL_DATABASE=
MYSQL_USER=
MYSQL_PASSWORD=
MYSQL_ROOT_PASSWORD=

/sensitive.env

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
TOKEN_SECRET=
REFRESH_TOKEN_SECRET=
FRONT_URI=
FRONT_REDIRECT_PATH=
BACK_URI=
SECRET_KEY= 
REDIS_HOST=

🏗 Architecture