Installation

디자인 시스템 라이브러리를 사용하기 위해서는 몇 가지 기본적인 단계를 따라야 합니다. 아래 지침에 따라 설정을 완료해주세요.

Settings

Node.js

라이브러리를 사용하기 위해 v16 이상의 Node.js 버전이 필요합니다.

GitHub Package 설정

구름톤 관계자들에게는 추후 별도 공식 오픈소스(vapor-ui) 설치 방법을 제공할 예정입니다.

@goorm-dev 패키지를 설치하려면 GitHub Personal Access Token이 필요합니다.

프로젝트 루트 디렉토리 또는 사용자 홈 디렉토리의 .npmrc 파일에 토큰을 추가하세요:

@goorm-dev:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Library Installation

Peer dependencies

Vapor Core를 설치하기 전에 다음의 하위 의존성 패키지를 설치해야 합니다.

"dependencies": {
  "react": ">=18",
  "react-dom": ">=18",
},

Dependencies

애플리케이션에서 사용할 패키지를 추가합니다:

PackageDescription
@goorm-dev/vapor-core최소한의 기능 제약, 최대한의 형태 커스텀이 가능한 React 컴포넌트 라이브러리
@goorm-dev/vapor-iconsVapor 디자인 시스템을 구성하는 React 아이콘 라이브러리
@goorm-dev/vapor-hooksVapor 디자인 시스템을 구성하는 React 훅 라이브러리
npm install @goorm-dev/vapor-core @goorm-dev/vapor-icons