Skip to content

Home

Jump to bottom
SangYeon Min edited this page Oct 28, 2024 · 7 revisions

Welcome to the HEARUS-SPRING-BACKEND wiki!

API Document

REST API Document

ν”„λ‘œμ νŠΈ ꡬ쑰

/main/java/com/hearus/hearusspring
β”‚
β”œβ”€β”€ common/
β”‚   β”œβ”€β”€ enumType/ # ν”„λ‘œμ νŠΈμ— ν•„μš”ν•œ λ‹€μ–‘ν•œ enumType듀을 μ •μ˜
β”‚   β”œβ”€β”€ environment/ # ν™˜κ²½λ³€μˆ˜ (DB, JWT) 등을 ν”„λ‘œμ νŠΈμ— import
β”‚   β”œβ”€β”€ exception/ # ν”„λ‘œμ νŠΈμ—μ„œ λ°œμƒν•˜λŠ” μ˜ˆμ™Έ 처리 κ΄€λ ¨ Class μ •μ˜
β”‚   β”œβ”€β”€ ffmpeg/ # ffmpeg 라이브러리 μ‚¬μš©μ„ μœ„ν•œ Class μ •μ˜
β”‚   β”œβ”€β”€ security/ # JWTProvider λ“± Security κ΄€λ ¨ 클래슀 μ •μ˜
β”‚   └── CommonResponse.java # μΌκ΄€λœ ν˜•νƒœλ‘œ 응닡을 보내기 μœ„ν•œ Class
β”‚
β”œβ”€β”€ controller/
β”‚   └── # API μ„œλ²„λ₯Ό κ΅¬μΆ•ν•˜κΈ° μœ„ν•œ RESTful Controller μ •μ˜
β”‚
β”œβ”€β”€ data/
β”‚   β”œβ”€β”€ dao/ # Entity, Repositoryλ₯Ό 톡해 DB μž‘μ—… κ΄€λ ¨ Class μ •μ˜
β”‚   β”œβ”€β”€ dto/ # FE Reqλ₯Ό 받아듀이기 μœ„ν•œ Data Transfer Object
β”‚   β”œβ”€β”€ entity/ # DBμ™€μ˜ μž‘μ—…μ„ μœ„ν•œ 데이터 Class μ •μ˜
β”‚   β”œβ”€β”€ model/ # NoSQL DBμ™€μ˜ μž‘μ—…μ„ μœ„ν•œ Model Class μ •μ˜
β”‚   β”œβ”€β”€ oauth/ # OAuth κ΅¬ν˜„ κ΄€λ ¨ 데이터 Class μ •μ˜
β”‚   └── repository/ # JPAλ₯Ό 톡해 Queryλ₯Ό μ‹€ν–‰ν•˜λŠ” Class μ •μ˜
β”‚
β”œβ”€β”€ service/
β”‚   └── # Controller와 DAO Class μ‚¬μ΄μ—μ„œ μž‘μ—…μ„ μˆ˜ν–‰ν•˜λŠ” Class μ •μ˜
β”‚
└── webrtcProxy/
    β”œβ”€β”€ SocketIOCommandLineRunner.java # SocketIO μ„œλ²„ ꡬ동 Class
    β”œβ”€β”€ SockerIOConfig.java # SocketIO μ„œλ²„μ™€ κ΄€λ ¨λœ 섀정을 μ •μ˜ν•˜λŠ” Class
    β”œβ”€β”€ WebRTCProxy.java # WebRTC ν˜•νƒœλ₯Ό μ°¨μš©ν•˜μ—¬ μ‹€μ‹œκ°„ 연결을 μ€‘μž¬
    └── WebSocketUtil.java # WebSocket κ΄€λ ¨ 섀정을 μ •μ˜ν•˜λŠ” Class

Entitiy-Relationship-Diagram

image

μ‹œμž‘ν•˜κΈ°

ν•„μˆ˜ μš”κ΅¬μ‚¬ν•­

  • Java OpenJDK 21.0.2
  • Gradle
  • MariaDB, MongoDB
  • ffmpeg

μ„€μΉ˜ 및 μ‹€ν–‰

  1. λ ˆν¬μ§€ν† λ¦¬ clone

    git clone https://github.com/TEAM-Hearus/HEARUS-SPRING-BACKEND

  2. ν”„λ‘œμ νŠΈ λ””λ ‰ν„°λ¦¬λ‘œ 이동

    cd HEARUS-SPRING-BACKEND

  3. Gradle을 μ‚¬μš©ν•˜μ—¬ ν”„λ‘œμ νŠΈ λΉŒλ“œ

    ./gradlew build

  4. μ• ν”Œλ¦¬μΌ€μ΄μ…˜ μ‹€ν–‰

    java -jar build/libs/hearus-0.0.1-SNAPSHOT.jar

🀝 κΈ°μ—¬ν•˜κΈ°

Hearus의 λ°œμ „μ— κΈ°μ—¬ν•΄ μ£Όμ…”μ„œ κ°μ‚¬ν•©λ‹ˆλ‹€! μš°λ¦¬λŠ” λͺ¨λ“  ν˜•νƒœμ˜ κΈ°μ—¬λ₯Ό ν™˜μ˜ν•©λ‹ˆλ‹€.

  1. Issue 생성: 버그 리포트, κΈ°λŠ₯ μ œμ•ˆ, λ˜λŠ” 질문
  2. Pull Request: μ½”λ“œ κ°œμ„ , λ¬Έμ„œν™”, λ˜λŠ” μƒˆλ‘œμš΄ κΈ°λŠ₯ κ΅¬ν˜„
  3. Code Review: λ‹€λ₯Έ κΈ°μ—¬μžμ˜ PR을 λ¦¬λ·°ν•˜κ³  ν”Όλ“œλ°± 제곡
  4. Documentation: README, μœ„ν‚€, λ˜λŠ” μ½”λ“œ 주석 κ°œμ„ 

μžμ„Έν•œ κΈ°μ—¬ κ°€μ΄λ“œλΌμΈμ€ CONTRIBUTING.mdλ₯Ό μ°Έμ‘°ν•΄ μ£Όμ„Έμš”. λ˜ν•œ ν”„λ‘œμ νŠΈμ— λŒ€ν•œ λ¬Έμ˜μ‚¬ν•­μ΄ μžˆμœΌμ‹œλ‹€λ©΄ ISSUEλ₯Ό 생성해 μ£Όμ„Έμš”.

Clone this wiki locally