guide

Installation

Hướng dẫn cài design system bằng CLI. Phần này là điểm vào chính cho consumer trước khi xem từng component riêng lẻ.

1. Cài bằng CLI

Chạy lệnh init để copy design system vào project của bạn.

npx github:xizot/ui-design-system init

npx github:xizot/ui-design-system

npx github:xizot/ui-design-system help

2. Cấu trúc được copy vào project

CLI cài design system vào một thư mục đích riêng để dễ quản lý.

design-system/
  components/
  constants/
  hooks/
  lib/

3. CLI sẽ làm gì

Flow cài đặt hiện tại tập trung vào copy file và cài dependency cần thiết.

CLI kiểm tra file đã tồn tại trong thư mục đích và hỏi bạn muốn overwrite, skip hay review từng conflict.

Sau đó CLI kiểm tra package.json của project để cài thêm dependency runtime còn thiếu.

Package manager hỗ trợ: pnpm, yarn, bun, npm.

4. Import sau khi cài

Docs nên hướng dẫn consumer import từ thư mục đã được CLI copy vào.

import { Button } from '@/design-system/components/ui/button';