基本的なセットアップ

NotCMSを使用するには、スキーマと認証情報を使用してクライアントを初期化する必要があります:
import { Client } from 'notcms';
import { schema } from './notcms/schema';

const nc = new Client({
  schema,
  apiKey: process.env.NOTCMS_SECRET_KEY,
  workspaceId: process.env.NOTCMS_WORKSPACE_ID
});

前提条件

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

環境変数

必須変数

NOTCMS_SECRET_KEY=your-secret-key
NOTCMS_WORKSPACE_ID=your-workspace-id

環境変数の読み込み

// Next.jsは.envを自動的に読み込みます
import { Client } from 'notcms';

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

Next.js App Router

// app/lib/notcms.ts
import { Client } from 'notcms';
import { schema } from '@/notcms/schema';

// サーバー専用クライアント
export const nc = new Client({
  schema,
  apiKey: process.env.NOTCMS_SECRET_KEY!,
  workspaceId: process.env.NOTCMS_WORKSPACE_ID!
});

Remix

// app/lib/notcms.server.ts
import { Client } from 'notcms';
import { schema } from '~/notcms/schema';

// .server.ts拡張子でサーバー専用を明示
export const nc = new Client({
  schema,
  apiKey: process.env.NOTCMS_SECRET_KEY!,
  workspaceId: process.env.NOTCMS_WORKSPACE_ID!
});

SvelteKit

// src/lib/notcms.ts
import { Client } from 'notcms';
import { schema } from '../notcms/schema';
import { 
  NOTCMS_SECRET_KEY, 
  NOTCMS_WORKSPACE_ID 
} from '$env/static/private';

export const nc = new Client({
  schema,
  apiKey: NOTCMS_SECRET_KEY,
  workspaceId: NOTCMS_WORKSPACE_ID
});

トラブルシューティング

よくある問題

次のステップ

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