Farm.js Docs

Farm.js 文档（farmjs-docs）

Farm.js 的官方文档站点，使用 Farm.js 构建。

本地运行

在仓库根目录中运行：

pnpm install
pnpm run --filter farmjs-docs dev

或在此目录中运行（先在根目录执行 pnpm install）：

pnpm dev

打开 http://localhost:3000。

Agent 等候名单数据库

/agents 表单会向 /api/waitlist 提交数据。prisma/schema.prisma 中的 WaitlistEntry 会存储规范化后的电子邮件地址（唯一）、注册说明，以及创建和更新时间戳。 重复提交会更新现有记录，而不会创建重复记录。

在 docs/.env.local 中设置仅供服务端使用的 WAITLIST_DATABASE_URL，指向专用的 Postgres 数据库。绝不要为它添加 VITE_ 前缀，也不要提交凭据。未设置时，该路由 会继续使用 DATABASE_URL；遥测始终使用 DATABASE_URL。

在 docs 目录中，只需为新的专用数据库执行一次以下准备操作：

pnpm db:waitlist

此操作需要显式设置 WAITLIST_DATABASE_URL，并且只会在 WaitlistEntry 表不存在时创建该表。它绝不会重置数据库或修改遥测表。未来更改架构时，请确保 prisma/waitlist.sql 与 Prisma 模型保持一致；引导脚本不会升级现有表。

在生产环境中，将 WAITLIST_DATABASE_URL 设置在提供 farmjs.dev 服务的 Vercel 项目中， 作用范围设为 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 和源映射产物，但会跳过 TypeScript 声明生成，因为部署的网站不会使用 .d.ts 文件。 此优化适用于完整的 farmjs.dev 应用，包括着陆页和文档路由。

常规软件包和发布构建仍为默认构建，并会继续生成声明：

pnpm --filter @farm.js/core build

仅在应用部署需要可执行的运行时产物时使用 build:runtime。不要将其用于软件包发布、发布验证，或任何使用生成类型的工作流。

结构

• 着陆页（/）– 主视觉区、功能和行动号召
• 文档（/docs）– 文档索引
• 快速入门（/docs/getting-started）– 安装和入门步骤
• 路由（/docs/routing）– 基于文件的路由
• 布局（/docs/layouts）– 根布局和嵌套布局