리옵트 데이터 문서
플랫폼과 개발

로컬 개발

웹 앱, docs, worker, 분리 서비스를 로컬에서 실행하고 검증하는 명령을 정리합니다.

로컬에서는 먼저 웹 앱만 띄워 UI와 docs를 확인하고, 필요할 때 worker나 분리 서비스를 추가하세요. 처음에는 pnpm dev로 충분합니다.

실행 명령

pnpm dev
pnpm dev:min
pnpm dev:core
pnpm dev:full
pnpm dev:control-api
pnpm dev:query-api
pnpm dev:realtime-service
pnpm dev:export-service
pnpm dev:ingest-worker
  • pnpm dev: 기본 최소 모드. 내부적으로 dev:min을 실행
  • pnpm dev:min: @reopt/web만 실행해 랜딩, 로그인, /docs, control plane fallback을 가장 빠르게 확인
  • pnpm dev:core: 웹 + ingest worker
  • pnpm dev:full: 분리 서비스까지 전체 실행
  • pnpm dev:*: 특정 data plane 서비스만 따로 실행

웹 앱 전용 명령

cd apps/web
pnpm dev
pnpm lint
pnpm check-types
pnpm build

docs 수정 위치

  • 콘텐츠: apps/web/content/docs
  • docs layout: apps/web/app/docs
  • source 설정: apps/web/source.config.ts
  • search route: apps/web/app/api/docs/search/route.ts

로컬 인프라

pnpm docker:up
pnpm --filter @reopt/db db:push
pnpm --filter @reopt/db db:clickhouse:init

docker-compose.yml은 PostgreSQL을 호스트 포트 5433에 노출합니다. 로컬 .envDATABASE_URLlocalhost:5433을 사용하세요.

MotherDuck local file 모드를 쓰면 ClickHouse 컨테이너 없이 PostgreSQL과 Redis만으로 개발할 수 있습니다. 자세한 백엔드 차이는 분석 백엔드 선택을 보세요.

이번 문서 계층의 원칙

  • 서비스 IA 기준으로 섹션을 나눕니다.
  • capability taxonomy는 보조 설명으로 매핑합니다.
  • flat slug 대신 nested slug를 사용합니다.
  • 기존 공개 slug는 redirect로 호환성을 유지합니다.

검증 순서

  1. pnpm --filter @reopt/web check-types로 route type과 MDX 빌드 타입을 확인합니다.
  2. 로컬 서버에서 /docs를 열어 문서 렌더링을 확인합니다.
  3. 링크를 수정했다면 실제 라우트가 존재하는지 확인합니다.

다음 단계