Backend-V1

Kotlin과 Spring Boot 3 기반의 백엔드 시작 템플릿입니다. 인증, 보안 설정, 헬스 체크, 예외 응답, 테스트 기본 구조를 포함합니다.

GitHub 템플릿으로 사용하기

1. GitHub 저장소의 Settings > General > Template repository 옵션을 켭니다.
2. 새 프로젝트를 만들 때 Use this template 버튼으로 저장소를 생성합니다.
3. 생성된 저장소에서 아래 항목을 프로젝트에 맞게 변경합니다.

파일	변경할 내용
settings.gradle.kts	rootProject.name
build.gradle.kts	group, version
src/main/resources/application.yml	spring.application.name, server.port
src/main/kotlin/...	기본 패키지명
src/test/kotlin/...	테스트 패키지명

기술 스택

• Kotlin 1.9
• Spring Boot 3.3
• Spring Security
• Gradle Kotlin DSL
• JUnit 5
• Java 21

프로젝트 구조

src/main/kotlin/com/teamnative/backend
├── Application.kt
├── domain
│   ├── auth
│   │   ├── controller
│   │   └── dto
│   ├── health
│   └── sample
└── global
    ├── config
    └── exception

실행

macOS 또는 Linux:

./gradlew bootRun

Windows PowerShell:

.\gradlew.bat bootRun

테스트

./gradlew test

Windows PowerShell:

.\gradlew.bat test

확인용 API

• GET /health
• GET /api/v1/public/ping
• GET /api/v1/private/ping
• POST /api/v1/auth/login

템플릿 유지보수

• .github/workflows/ci.yml: Pull request와 main 브랜치 push 시 테스트를 실행합니다.
• .github/dependabot.yml: Gradle과 GitHub Actions 의존성 업데이트 PR을 주기적으로 생성합니다.
• .github/pull_request_template.md: 새 프로젝트에서도 기본 PR 체크리스트를 제공합니다.