Farm.js Docs

Farm.js Docs (farmjs-docs)

Farm.js で構築された、Farm.js の公式ドキュメントサイトです。

ローカルで実行する

リポジトリのルートから実行します：

pnpm install
pnpm run --filter farmjs-docs dev

または、このディレクトリから実行します（ルートで pnpm install を実行した後）：

pnpm dev

http://localhost:3000 を開きます。

エージェントのウェイトリストデータベース

/agents フォームは /api/waitlist に送信します。prisma/schema.prisma の WaitlistEntry は、正規化されたメールアドレス（一意）、登録時の説明、作成日時と更新日時を保存します。 重複して送信された場合は、新しいレコードを作成するのではなく、そのレコードを更新します。

専用の Postgres データベースを使用するには、docs/.env.local にサーバー専用の WAITLIST_DATABASE_URL を設定します。VITE_ を前置したり、認証情報をコミットしたりしないでください。省略した場合、ルートは引き続き DATABASE_URL を使用し、テレメトリーでは常に DATABASE_URL が使用されます。

docs から、新しい専用データベースを一度だけ準備します：

pnpm db:waitlist

これには WAITLIST_DATABASE_URL の明示的な設定が必要で、WaitlistEntry テーブルが存在しない場合にのみ作成されます。データベースをリセットしたり、テレメトリーテーブルを変更したりすることはありません。今後スキーマを変更する場合に備えて、prisma/waitlist.sql を Prisma モデルと一致させてください。このブートストラップ処理は、既存のテーブルをアップグレードしません。

本番環境では、farmjs.dev を提供する Vercel プロジェクトに WAITLIST_DATABASE_URL を設定し、スコープを Production にしてから、更新したアプリをデプロイします。既存のテレメトリー用 DATABASE_URL を置き換えたり、PR プレビューから本番のウェイトリストにアクセスできるようにしたりしないでください。デプロイ後に登録を受け付ける前に、同じデータベースに対してブートストラップ処理を適用してください。ビルド中にスキーマ変更が自動で実行されることはありません。

Farm の開発環境では .env.local が読み込まれます。リポジトリのルートから、ローカルでビルドした Node 出力を実行するには：

node --env-file=docs/.env.local docs/.farm/.output/server/index.mjs

ビルド

リポジトリのルートから実行します：

pnpm run --filter farmjs-docs build

本番用の Vercel アーティファクトは .vercel/output に出力されます。

ランタイム専用のコアビルド

ドキュメントサイトのビルドでは、@farm.js/core のランタイム専用パッケージビルドを選択します：

pnpm --filter @farm.js/core build:runtime

これにより、デフォルトのコアビルドと同じ ESM、CJS、ソースマップのアーティファクトがビルドされますが、デプロイされたウェブサイトでは .d.ts ファイルを使用しないため、TypeScript の宣言ファイル生成はスキップされます。この最適化は、ランディングページとドキュメントルートを含む farmjs.dev アプリケーション全体に適用されます。

通常のパッケージおよびリリースビルドは引き続きデフォルトであり、宣言ファイルも引き続き生成されます：

pnpm --filter @farm.js/core build

build:runtime は、実行可能なランタイムアーティファクトを必要とするアプリケーションのデプロイにのみ使用してください。パッケージの公開、リリースの検証、または生成された型を使用するワークフローには使用しないでください。

構成

• ランディングページ（/） – ヒーロー、機能、CTA
• ドキュメント（/docs） – ドキュメントの目次
• はじめに（/docs/getting-started） – インストールと最初の手順
• ルーティング（/docs/routing） – ファイルベースのルーティング
• レイアウト（/docs/layouts） – ルートおよびネストされたレイアウト