Getting Started

📝 신입 개발자를 위한 초기 세팅 가이드 (10분 소요)

서버 관리자 백엔드 파트에 합류하신 것을 환영해요! 🤗 아래 순서에 따라 로컬 개발 환경 설정을 완료해 주세요.

1. 기술 스택 확인

• IDE: IntelliJ (설치 권장, 학생 계정이라면 Ultimate 사용을 추천해요.)
• Java Version: Java 17 (로컬에 자바가 설치되어있어야 합니다!)
• Framework: Spring Boot (설정 필요 없음)

2. 설정 파일(application.yml) 준비

• 보안상 설정 파일은 레포지토리에 포함되어 있지 않습니다.
• 관리자용 Notion > BE 페이지 > application.yml 페이지에 접속합니다.
• application.yml의 내용을 전체 복사합니다.
• application.yml을 업데이트할 시에는 이 페이지에 꼭 수정해주고, PR로도 수정했음을 명시해주세요⚠️
• 프로젝트 경로 src/main/resources/ 아래에 application.yml 파일을 새로 생성하고 내용을 붙여넣습니다.
• application.yml을 커밋하는 실수가 없도록 .gitignore 설정이 되어있어요.😀

3. 로컬 DB 및 프로파일 설정

• DB 생성: 로컬 MySQL에서 web-admin 이름의 데이터베이스를 생성합니다.
• 사용자, 비밀번호, 포트 번호 설정은 자율적으로 진행해주세요.

CREATE DATABASE `web-admin`;

• 연동 설정: application.yml의 local 프로파일 섹션에서 본인의 로컬 DB username과 password가 맞는지 확인합니다.
• 프로파일 활성화: spring.profiles.active 설정이 local로 되어 있는지 확인합니다. (application.yml의 맨 위에 있어요!)

• 예시 설정 코드입니다.

# 로컬 환경 설정(본인 로컬 환경 설정)
---
api:
  base-url: http://localhost:8080

logging:
  level:
    org.hibernate.SQL: debug
    org.hibernate.type.descriptor.sql.BasicBinder: trace
spring:
  config:
    activate:
      on-profile: local
  datasource: #본인 로컬 DB 설정하기
    url: jdbc:mysql://localhost:3307/web_admin?serverTimezone=Asia/Seoul&useSSL=false&allowPublicKeyRetrieval=true
    username: root
    password: toni1234

4. 의존성 로드 (Gradle)

• IntelliJ 우측의 Gradle 탭을 클릭합니다.
• Reload All Gradle Projects (🐘 코끼리 모양 리프레시 아이콘)를 클릭하여 필요한 라이브러리를 모두 다운로드합니다.

5. 인코딩 설정 (중요: 한글 깨짐 방지)

• 메시지 파일(message.properties)의 한글이 깨지지 않도록 반드시 아래 설정을 완료해야 합니다.
• Settings (Ctrl+Alt+S 또는 cmd + ,) > Editor > File Encodings 이동
• 하단의 Properties Files (.properties) 설정 변경:

Default encoding: UTF-8
Transparent native-to-ascii conversion: ✅ 체크

• Apply 후 확인

6. 애플리케이션 실행

• src/main/java/.../AdminBeApplication.java (메인 클래스)를 찾습니다.
• Run 버튼을 눌러 실행합니다.
• 콘솔에 에러 없이 로그가 올라오고 실행되는지 확인합니다.
• Mac OS에서 netty 에러(MacOSDnsServerAddressStreamProvider)는 무시해도 됩니다. (시스템 기본값으로 대체되어 로컬 실행 시 문제가 없으므로 무시하고 진행하셔도 됩니다.)

7. Swagger 확인하기

• 이제 스프링이 잘 띄워졌는지 확인하러 가요.
• Swagger는 프론트엔드 개발자와 더 잘 협업하기 위한 API 문서입니다.
• http://localhost:8080/swagger-ui/index.html#/에 접속해주세요.
• 접속되지 않는다면, 본인이 application.yml에 설정한 포트 번호와 8080이 일치하는지 확인해주세요.
• 만약 8080을 사용할 수 없다면, 8080 프로세스를 강제 종료하거나 다른 포트를 사용해주세요.

8. 문제가 발생했나요?

• 이미 한글이 깨져서 보인다면: 5번 설정을 다시 확인하고, 이미 깨진 파일은 정상 텍스트를 다시 붙여넣으세요. (깃허브에 다행히 있으니까요~)
• DB 연결 에러가 난다면: web-admin 스키마 생성 여부와 비밀번호를 다시 확인하세요. 그래도 동작하지 않는다면 해당 포트에서 다른 DB가 돌아가고 있는지 확인해보세요. (당신이 잘못했을 확률 99%)
• 기타 문의: 선배 관리자나 팀원에게 언제든 편하게 질문해 주세요! 혼자 하는 것보다 같이가 빨라요 🫂

세팅을 완료하셨나요﹖

그러면 이제 위키 오른쪽의 '목차' 탭에서 어떻게 동작하는지 살펴보러 가요 ➡️