Board SDK Monorepo

このリポジトリは、Board API のSDK、サンプルアプリケーション、および関連ツールを含むモノレポです。

パッケージ構成

このモノレポは以下のパッケージで構成されています：

• packages/sdk: Board API SDK本体
• packages/examples: Honoを使用したSDKの使用例
• packages/mcp: SDKを利用したModel Context Protocolサーバー

開発環境のセットアップ

必要条件

• Node.js 18.0.0以上
• npm 7.0.0以上

インストール

# リポジトリをクローン
git clone https://github.com/digitalcube/board-sdk.git
cd board-sdk

# 依存関係のインストール
npm install

開発サーバーの起動

# 全パッケージの開発サーバー起動
npm run dev

# 特定のパッケージのみ開発サーバー起動
npm run dev --workspace=@digitalcube/board-sdk
npm run dev --workspace=@board-sdk/examples
npm run dev --workspace=@board-sdk/mcp

ビルド

# 全パッケージのビルド
npm run build

# 特定のパッケージのみビルド
npm run build --workspace=@digitalcube/board-sdk
npm run build --workspace=@board-sdk/examples
npm run build --workspace=@board-sdk/mcp

パッケージの公開 (@sdk)

@digitalcube/board-sdk パッケージを npm に公開する手順は以下の通りです。

1. バージョンの更新: packages/sdk/package.json ファイルを開き、"version" フィールドを適切な新しいバージョン番号に更新します（例: "0.1.1"）。

2. npm へのログイン (初回または必要時):

   npm login

   ユーザー名、パスワード、メールアドレス、およびワンタイムパスワード（2FAが有効な場合）を入力します。

3. パッケージディレクトリへの移動:

   cd packages/sdk

4. 公開の実行:

   npm publish --access public

   公開スコープのパッケージ (@digitalcube/) のため、--access public が必要です（プライベートパッケージとして公開する場合は不要）。

公開が成功すると、npm レジストリ上でパッケージが利用可能になります。

環境変数

各パッケージで使用する環境変数は、それぞれのパッケージディレクトリに .env ファイルを作成して設定します。

SDK

BOARD_API_KEY=your_api_key
BOARD_API_BASE_URL=https://api.example.com

Examples & MCP

BOARD_API_KEY=your_api_key
BOARD_API_BASE_URL=https://api.example.com
PORT=3000 # Examples用のポート番号（デフォルト：3000）
PORT=4000 # MCP用のポート番号（デフォルト：4000）

ライセンス

MIT