基本的なセットアップ
NotCMSを使用するには、スキーマと認証情報を使用してクライアントを初期化する必要があります:前提条件
クライアントを初期化する前に、以下を確認してください:- スキーマの生成 -
npx notcms initで最初のスキーマを生成し、npx notcms pullで更新 - 環境変数 - API認証情報の設定
- NotCMSのインストール - プロジェクトの依存関係に
notcmsを追加
環境変数
必須変数
環境変数の読み込み
- Next.js
- Node.js
- Vite
- Cloudflare Workers
フレームワーク別のセットアップ
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を実行してスキーマを生成- インポートパスが正しいことを確認
- スキーマファイルが正しくエクスポートされていることを確認
TypeScriptエラー
TypeScriptエラー
- NotCMSを最新バージョンに更新
npx notcms pullでスキーマを再生成- TypeScriptバージョンの互換性を確認
次のステップ
クライアントを初期化したら、以下の操作ができます:アイテムの一覧取得
データベースから複数のアイテムをクエリ
単一アイテムの取得
IDによる個別アイテムの取得