https://github.com/digitalcube/board-sdk
https://github.com/digitalcube/board-sdk
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/digitalcube/board-sdk
- Owner: digitalcube
- Created: 2025-04-28T07:13:43.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-05-29T05:19:26.000Z (8 months ago)
- Last Synced: 2025-07-29T11:12:18.691Z (6 months ago)
- Language: TypeScript
- Size: 87.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Board SDK Monorepo
このリポジトリは、Board API のSDK、サンプルアプリケーション、および関連ツールを含むモノレポです。
## パッケージ構成
このモノレポは以下のパッケージで構成されています：
- [`packages/sdk`](./packages/sdk): Board API SDK本体
- [`packages/examples`](./packages/examples): Honoを使用したSDKの使用例
- [`packages/mcp`](./packages/mcp): SDKを利用したModel Context Protocolサーバー
## 開発環境のセットアップ
### 必要条件
- Node.js 18.0.0以上
- npm 7.0.0以上
### インストール
```bash
# リポジトリをクローン
git clone https://github.com/digitalcube/board-sdk.git
cd board-sdk
# 依存関係のインストール
npm install
```
### 開発サーバーの起動
```bash
# 全パッケージの開発サーバー起動
npm run dev
# 特定のパッケージのみ開発サーバー起動
npm run dev --workspace=@digitalcube/board-sdk
npm run dev --workspace=@board-sdk/examples
npm run dev --workspace=@board-sdk/mcp
```
### ビルド
```bash
# 全パッケージのビルド
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 へのログイン (初回または必要時):**
```bash
npm login
```
ユーザー名、パスワード、メールアドレス、およびワンタイムパスワード（2FAが有効な場合）を入力します。
3. **パッケージディレクトリへの移動:**
```bash
cd packages/sdk
```
4. **公開の実行:**
```bash
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