@caroainc/ui-components

@caroainc/ui-components

社内プロダクト向け共通UIコンポーネントライブラリ

開発ガイド

セットアップ

git clone https://github.com/caroainc/caroa-ui.git
cd caroa-ui
npm install

開発サーバー

npm run dev                      # ライブラリのwatch mode
cd docs-site && npm run dev      # ドキュメントサイト起動 (localhost:3000)

新しいコンポーネントの追加

1. src/components/ComponentName/ ディレクトリを作成
2. コンポーネントファイルと型定義ファイルを作成
3. src/components/index.ts でexport
4. docs-site/content/docs/components/ にドキュメント（.mdx）を作成
5. デフォルトvariantは必ず base に設定

コミットルール

自動バージョニングのため、以下の形式でコミット：

fix: バグ修正           → patch (0.1.0 → 0.1.1)
feat: 新機能追加        → minor (0.1.0 → 0.2.0)
feat!: 破壊的変更       → major (0.1.0 → 1.0.0)
chore: その他 [skip ci] → バージョン変更なし

ビルド

npm run build        # 本番ビルド
npm run type-check   # 型チェック

利用者向けドキュメント

利用者向けのセットアップ・使い方は ドキュメントサイト を参照してください。

リンク

• ドキュメント
• GitHub
• npm

ライセンス

MIT 2025 Caroa, Inc.