SDK とクライアントライブラリ
TeamDay プラットフォームの上でアプリケーションを構築するための公式 SDK とクライアントライブラリ。
概要
TeamDay はプラットフォームの上で構築するためのクライアントライブラリを提供します。すべての SDK は Firebase を基盤として使用し、リアルタイムデータ用に Firestore、認証に Firebase Auth を使用します。
| SDK | 状態 | 言語 | ユースケース |
|---|---|---|---|
| JavaScript/TypeScript SDK | ✅ 本番 | TypeScript | Web アプリ (Nuxt/Vue) |
| REST API | 🚧 計画 | N/A | サーバー側統合 |
| Python SDK | 📋 ロードマップ | Python | スクリプト、オートメーション |
| CLI ツール | ✅ 本番 | TypeScript | 開発ワークフロー |
JavaScript/TypeScript SDK
プライマリ SDK は Vue 3 コンポーザブルで構築され、Nuxt 3 アプリケーションとシームレスに機能します。
インストール
# bun を使用 (推奨)
bun add firebase firebase/firestore
# npm を使用
npm install firebase
設定
// nuxt.config.ts
export default defineNuxtConfig({
runtimeConfig: {
public: {
firebase: {
apiKey: process.env.NUXT_PUBLIC_FIREBASE_API_KEY,
authDomain: process.env.NUXT_PUBLIC_FIREBASE_AUTH_DOMAIN,
projectId: process.env.NUXT_PUBLIC_FIREBASE_PROJECT_ID,
storageBucket: process.env.NUXT_PUBLIC_FIREBASE_STORAGE_BUCKET,
messagingSenderId: process.env.NUXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID,
appId: process.env.NUXT_PUBLIC_FIREBASE_APP_ID,
}
}
}
})
コアコンポーザブル
認証 - useAuth()
ユーザー認証とセッション状態を管理します。
詳細については、SDK とクライアントライブラリ を参照してください。