Malt

Malt는 Kotlin과 Spring Boot로 만들어져 IntelliJ IDEA를 사용하여 개발되었으며 Docker 및 Docker Compose로 로컬에서 설정할 수 있는 모델 기반 이미지 분류를 위한 SuperbAI 생성형 모델 API 관리 서비스입니다.

설치

이 프로젝트를 실행하려면 Docker와 Docker Compose가 설치되어 있어야 합니다.

필수 조건

1. Docker
2. Docker Compose
3. Intellij IDEA(선택 사항)
4. Postman(선택 사항)

설정

1. 로컬 머신에 저장소를 클론합니다:

   git clone <https://github.com/Superb-AI-Suite/malt.git>
   
   

2. 프로젝트 디렉토리로 이동합니다:

   cd malt
   
   

3. Docker Compose 명령을 실행하여 API 서버와 MySQL 데이터베이스를 설정합니다:

   docker-compose up
   
   

이제 Malt가 로컬에서 실행 중입니다.

구조

프로젝트는 Kotlin Spring Boot 프로젝트 구조를 따릅니다:

src.docs.asciidoc
├── index.adoc          # 프로젝트 API 문서화를 위한 RestDoc 설정을 포함합니다.

src.main.kotlin.com.superbai.malt
├── common              # 여러 패키지에서 사용되는 공통 클래스 또는 인터페이스
├── config              # 애플리케이션 구성 관련 클래스
├── controller          # REST API 엔드포인트
├── domain              # API 레이어 및 데이터베이스 엔터티를 위한 데이터 전송 객체
  ├── dto               # API 레이어를 위한 데이터 전송 객체
  ├── entity            # 데이터베이스 엔터티
└── exception           # 애플리케이션 특수 요구 사항에 맞는 사용자 정의 예외
└── mapper              # DTO를 엔터티로 변환하거나 그 반대로 변환하는 매핑 클래스
└── repository          # JPA 리포지토리
└── service             # 서비스 클래스(비즈니스 로직)
└── MaltApplication.kt  # 애플리케이션 진입점

src.main.resources
├── static.docs
   ├── index.html       # Restdocs 출력물
├── application*.yml    # 프로젝트 설정

src.test.kotlin.com.superbai.malt
├── api                 # HTTP 관련 테스트
├── controller          # 컨트롤러 레이어의 테스트를 포함하며 Restdocs 설정도 포함됩니다.

사용 방법

IntelliJ IDEA

중요: 이 방법은 Docker API 서버와 함께 작동하지 않습니다! 개발 모드에서만 사용 가능합니다.