🛠️ 프로젝트 구동을 위한 설정

프로젝트 설치부터 구동까지 일련의 과정을 담아봤습니다 :)

온보딩 과정에 활용해주세요!

git clone

git clone https://github.com/BCSDLab/KOIN_API_V2

Docker Desktop 설치

본 프로젝트에서는 TestContainer를 활용하여 테스트를 구동합니다. 테스트를 구동하기 위해 Docker를 설치해야합니다.

각 OS에 맞는 Docker Desktop을 설치해주세요!

설치 사이트: https://www.docker.com/products/docker-desktop/

도입배경 및 TestContainer 초기 설정 과정은 아래 블로그를 참고해주세요

• 블로그 - TestContainer 적용하기

Database 설정하기

KOIN 서비스는 MySQL, Redis, MongoDB를 사용합니다.

로컬에 모든 DB를 설치하는게 부담된다면 Docker를 활용하여 아주아주 편하게 구성할 수 있습니다.

• 🐳 Docker를 활용하여 DB 환경 구성하기 (GUI)
• 🐳 Docker를 활용하여 DB 환경 구성하기 (CLI)

GUI, CLI 본인이 선호하는 방식에 맞게 참고하여 구성하면됩니다.

⚙️ 프로젝트 설정파일 구성

• 설정 보러가기: https://github.com/BCSDLab/KOIN_API_V2/wiki/%E2%9A%99%EF%B8%8F-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%84%A4%EC%A0%95%ED%8C%8C%EC%9D%BC-%EA%B5%AC%EC%84%B1

Q: DB는 MySQL, Redis, Mongo 3개를 사용하는데 포트 설정은 왜 MySQL만 있나요?

A: 각각의 DB에 대해서 default port를 사용하기 때문에 application.yml에 별도로 redis, mongo에 대한 포트 설정이 없습니다!

SpringBoot에서 각 DB에 대한 default 값을 설정해뒀습니다.

default port 참고

• MySQL: 3306
• Redis: 6379
• Mongo: 27017

테스트 구동해보기

로컬에서 테스트를 구동해볼 수 있습니다.

로컬에서 실행하기

swagger 접속해보기

• http://localhost:8080/swagger-ui/index.html

/depts API 호출해보기

• http://localhost:8080/depts