メインコンテンツへスキップ
NotCMSをプロジェクトに設定し、数分でNotionからコンテンツの取得を開始しましょう。

​
前提条件

始める前に、以下を確認してください：
  • Node.js 12以上がインストールされていること
  • 少なくとも1つのデータベースを持つNotionアカウント
  • TypeScriptの基本的な知識（推奨）

​
ステップ1: NotCMSをインストール

npm install notcms

​
ステップ2: プロジェクトを初期化

NotCMS CLIを使用してプロジェクトをセットアップ： 
npx notcms-kit init
このコマンドは以下を実行します：
  1. 環境変数を確認
  2. notcms.config.json設定ファイルを作成

​
ステップ3: 環境変数を設定

.envファイルにNotCMS認証情報を追加： 
NOTCMS_SECRET_KEY=your-secret-key
NOTCMS_WORKSPACE_ID=your-workspace-id
認証情報はNotCMSダッシュボードから取得してください

​
ステップ4: スキーマを取得

NotionデータベースからTypeScript型を生成： 
npx notcms-kit pull
これにより、src/notcms/schema.tsにタイプセーフなスキーマファイルが作成されます： 
export const schema = {
  blog: {
    id: "abc123...",
    properties: {
      title: "title",
      published: "checkbox",
      author: "rich_text",
      tags: "multi_select"
    }
  }
} satisfies Schema;

​
ステップ5: NotCMSを使い始める

クライアントを作成してコンテンツのクエリを開始： 
import { Client } from 'notcms';
import { schema } from './notcms/schema';

const nc = new Client({ schema });

// 公開されたブログ記事をすべて取得
const [posts, error] = await nc.query.blog.list();

if (error) {
  console.error("記事の取得に失敗しました:", error);
} else {
  posts.forEach(post => {
    console.log(post.title);
  });
}

​
次は何をする？

設定

高度な設定オプションについて学ぶ

SDKリファレンス

完全なSDK APIを探索

エラーハンドリング

適切なエラー処理方法を学ぶ

Next.jsの例

完全なNext.js統合を見る

​
よくある問題

.envファイルがプロジェクトルートにあり、dotenvやdotenvxなどのパッケージを使用して読み込んでいることを確認してください。
Notionデータベースに正しい権限があり、APIキーがアクセスできることを確認してください。
Notionデータベースに変更を加えた場合は、npx notcms-kit pullを再度実行してスキーマを再生成してください。
⌘I