🍯 허니보드 API 서버

React 기반 프론트엔드와 연동되는 RESTful API 서버입니다.
게시판 기능을 제공하며, 사용자들이 자유롭게 소통할 수 있는 플랫폼을 위한 백엔드를 제공합니다.

📱 연관 프로젝트

• 프론트엔드: honeyboard-client
  • React 18 기반의 웹 클라이언트
  • Material-UI를 활용한 반응형 디자인
  • Redux를 통한 상태 관리

👥 팀원 소개

zyu22 👑 백엔드 팀장

kkangssu 🔨 백엔드 개발

rpeowiqu 🔨 백엔드 개발

yujeong789 🔨 백엔드 개발

SungMoonPark 🔨 백엔드 개발

## 🛠 기술 스택

백엔드
데이터베이스
인프라

📋 API 명세(수정중-추후 노션주소도 포함될 예정)

상세 API 문서는 Swagger UI를 통해 제공됩니다: API문서

📋 데이터베이스 설계 (수정중)

ERD

erDiagram
    Users ||--o{ User_Roles : has
    Users ||--o{ Posts : writes
    Users ||--o{ Comments : writes
    Boards ||--o{ Posts : contains
    Posts ||--o{ Comments : has
    
    Users {
        bigint user_id PK
        string email
        string username
        string nickname
        datetime created_at
    }
    Posts {
        bigint post_id PK
        bigint board_id FK
        bigint user_id FK
        string title
        string content
        datetime created_at
        datetime updated_at
    }

Loading

🚀 주요 기능

👤 인증 및 보안

• JWT 기반 인증
• Spring Security를 활용한 보안
• OAuth2.0 소셜 로그인
  • 구글 로그인 연동
  • 카카오 로그인 연동
  • 네이버 로그인 연동
• 소셜 계정과 로컬 계정 통합 관리

📝 API 기능

• RESTful API 설계
• 게시판/게시글/댓글 CRUD
• 페이징 및 검색
• 파일 업로드

🔍 성능 최적화

• 페이징 처리 최적화

💻 로컬 개발 환경 설정

필수 요구사항

- JDK 17
- Maven
- MySQL 8.0
- Docker (선택사항)

STS 실행 설정

1. 프로젝트 우클릭 → Run As → Run Configurations
2. Spring Boot App 선택
3. Arguments 탭 클릭
4. VM arguments에 다음 추가: -Dspring.profiles.active=dev

설치 및 실행

1. 저장소 복제

git clone https://github.com/zyu22/honeyboard-server.git
cd honeyboard-server

2. 환경 설정

cp src/main/resources/application.properties.example src/main/resources/application.properties
# 데이터베이스, Redis 등 설정 수정

3. 실행

mvn spring-boot:run

도커 실행

docker-compose up -d

📜 개발 규칙

Git 브랜치 전략

main (배포용)
└── develop (개발용)
    ├── feat/* (기능 개발)
    └── fix/* (버그 수정)

커밋 메시지

feat: 새로운 기능 추가
fix: 버그 수정
docs: 문서 수정
refactor: 코드 리팩토링
test: 테스트 코드
chore: 기타 변경사항

🌐 배포 구조

graph LR
    Client[프론트엔드<br/>React App] --> API[API Server<br/>Spring Boot] --> DB[(MySQL)]
    API --> Cache[(Redis)]

Loading

• GitHub Actions를 통한 자동 배포
• AWS EC2에 Docker로 운영
• NGINX를 통한 리버스 프록시

⏳ 개발 진행 상황

단계	상태
프로젝트 설정	✅
DB 설계	✅
API 문서 작성	🏗
사용자 인증	🏗
게시판 API	📝
배포 구성	📝

---

허니보드 백엔드 팀이 만든 ❤️ 프로젝트