メインコンテンツへスキップ

基本的なセットアップ

NotCMSを使用するには、スキーマと認証情報を使用してクライアントを初期化する必要があります:

前提条件

クライアントを初期化する前に、以下を確認してください:
  1. スキーマの生成 - npx notcms init で最初のスキーマを生成し、npx notcms pull で更新
  2. 環境変数 - API認証情報の設定
  3. NotCMSのインストール - プロジェクトの依存関係に notcms を追加

環境変数

必須変数

環境変数の読み込み

フレームワーク別のセットアップ

Next.js App Router

Remix

SvelteKit

生成されたスキーマのモジュールは読み込まれた時点で process.env を読むため、上の Vite のタブのとおり値を process.env へ入れてください。

トラブルシューティング

よくある問題

  • プロジェクトルートに .env.local ファイルが存在することを確認
  • 実行環境が .env.local を読み込んでいることを確認(node --env-file=.env.local、または dotenv のあとで生成クライアントを動的な import() で読み込むなど)
  • 生成された notcms/schema モジュールは、読み込まれた時点で環境変数を読みます。自分の Client に secretKey と workspaceId を渡しても、この読み込みは省けないため、先に環境変数へ設定してください(上の Vite と Cloudflare Workers のタブを参照)
  • 変数名が正確に一致していることを確認
  • NOTCMS_SECRET_KEY が正しいことを確認
  • NOTCMS_WORKSPACE_ID がワークスペースと一致することを確認
  • APIキーに必要な権限があることを確認
  • npx notcms pull を実行してスキーマを生成
  • インポートパスが正しいことを確認
  • スキーマファイルが正しくエクスポートされていることを確認
  • NotCMSを最新バージョンに更新
  • npx notcms pull でスキーマを再生成
  • TypeScriptバージョンの互換性を確認

次のステップ

クライアントを初期化したら、以下の操作ができます:

アイテムの一覧取得

データベースから複数のアイテムをクエリ

単一アイテムの取得

IDによる個別アイテムの取得