Home

DisplayU Backend Wiki

DisplayU는 대학생의 전시와 작품을 발견하고, 기록하고, 소통할 수 있는 전시 플랫폼입니다. 이 Wiki는 Backend 개발자가 프로젝트를 실행하고 협업하는 데 필요한 정보를 제공합니다.

빠른 시작

git clone https://github.com/UMC-DISPLAYU/Backend.git
cd Backend
cp .env.example .env
docker compose up -d
./gradlew bootRun

서버가 실행되면 아래 주소에서 상태와 API 문서를 확인할 수 있습니다.

• Health Check: http://localhost:8080/api/v1/health
• Swagger UI: http://localhost:8080/swagger-ui/index.html
• OpenAPI JSON: http://localhost:8080/v3/api-docs

.env의 필수 값은 실행 전에 로컬 환경에 맞게 설정해야 합니다.

가이드

문서	내용
Getting Started	로컬 환경 구성과 서버 실행
Development Guide	브랜치, 커밋, 테스트와 개발 규칙
API Guide	Swagger, 공통 응답과 API 기본 규칙
Architecture & Database	계층 구조와 Flyway 원칙
Deployment & Operations	CI/CD, 배포와 모니터링

프로젝트 링크

• Backend Repository
• GitHub Actions
• 서비스 바로가기

문서 관리 원칙

• Wiki에는 온보딩, 실행 방법, 협업 흐름을 정리합니다.
• 코드와 함께 변경되어야 하는 상세 설계는 Repository의 docs/에서 관리합니다.
• 같은 내용을 두 곳에 복사하지 않고 상세 문서의 원본 링크를 연결합니다.