Skip to main content

Quick Start

Prerequisites

Before starting, make sure the following tools are installed on your system.


0. Required environment setup

Create a .env file by copying .env.example, then configure the required environment variables.

cp .env.example .env

The following variables must be set:

  • HCX_API_KEY
  • All CLOVA_STUDIO_* related variables

For a detailed description of each variable, see the Environment Variables documentation.


1. Start the local environment

Start all required services using Docker Compose.

docker compose up -d

This will launch the backend, model server, and dependent services.


2. Backend initial setup

Initialize the backend with sample data and required internal state.

cd backend && make init

3. Model server initial setup

Set up the model server using sample data and default configurations.

cd model-server && make setup

4. Verify the services

Once all services are running, verify that each component is accessible.