Template

快速开始

在本地配置好模板,几分钟内让应用跑起来。

Template 是新 Zybric 应用的种子,包含语言路由、SEO 元数据、共享设计系统,以及使用 MDX 编写的文档、博客、法律和作者页面。

前置条件

  • 使用根目录 package.json 锁定的 Node.js 和 pnpm 版本。
  • 全局安装 Portless,用于本地 HTTPS URL。
  • 配置 direnv,使其加载检出目录及应用的 .envrc,并取得应用的 Vercel Development 环境访问权限。

配置工作区

把 VERCEL_TOKEN 写入主检出中被忽略的 .workspace/.env.local。在仓库根目录运行:

pnpm -w worktree:setup

该命令安装工作区依赖,并将各应用的 Vercel Development 配置拉取到被忽略的 .env。

启动 Template

在仓库根目录运行:

pnpm --filter template dev

主检出使用 https://template.zybric.localhost。Portless 会为各个工作树分配独立域名,请使用开发命令输出的 URL。

创建新应用

把 Template 复制到 apps/<your-app>。修改包的 name、portless.name,以及 dev、start 和 test:e2e 脚本中的应用名。按照仓库的应用接入流程,配置新应用的 Vercel 项目、凭据和部署环境,并把项目选择配置写入 workspace.env。

浏览器可见变量在 src/env/client.ts 中声明;服务端专用变量在 src/env/server.ts 中声明。运行时取值存放在 Vercel 中,并拉取到被忽略的 .env。配置约定见仓库的 docs/runbooks/environment.md。

项目结构介绍代码布局,撰写内容说明 MDX 的用法,i18n 与 SEO解释语言路由和元数据。

On this page