前提条件
始める前に、以下を確認してください:- Node.js 12以上がインストールされていること
- 少なくとも1つのデータベースを持つNotionアカウント
- TypeScriptの基本的な知識(推奨)
ステップ1: NotCMSをインストール
ステップ2: プロジェクトを初期化
NotCMS CLIを使用してプロジェクトをセットアップ:- 環境変数を確認
notcms.config.json設定ファイルを作成
ステップ3: 環境変数を設定
.envファイルにNotCMS認証情報を追加:
認証情報はNotCMSダッシュボードから取得してください
ステップ4: スキーマを取得
NotionデータベースからTypeScript型を生成:src/notcms/schema.tsにタイプセーフなスキーマファイルが作成されます:
ステップ5: NotCMSを使い始める
クライアントを作成してコンテンツのクエリを開始:次は何をする?
よくある問題
環境変数が読み込まれない
環境変数が読み込まれない
.envファイルがプロジェクトルートにあり、dotenvやdotenvxなどのパッケージを使用して読み込んでいることを確認してください。スキーマ生成が失敗する
スキーマ生成が失敗する
Notionデータベースに正しい権限があり、APIキーがアクセスできることを確認してください。
TypeScriptエラー
TypeScriptエラー
Notionデータベースに変更を加えた場合は、
npx notcms-kit pullを再度実行してスキーマを再生成してください。