用途:面向克隆 kickstart-next 仓库、本地运行或提交 PR 的开发者,说明本地需执行的操作与 CI 自动执行的内容。
本地设置:用 npm install 安装依赖;将 .env.example 复制为 .env,并填入 Contentstack stack 的值(见 README.md)。必需变量使用 NEXT_PUBLIC_CONTENTSTACK_* 前缀,具体名称见 .env.example。
Contentstack stack:安装 CLI(npm install -g @contentstack/cli),按提示配置区域并登录(csdx auth:login)。播种兼容 stack:csdx cm:stacks:seed --repo "contentstack/kickstart-stack-seed" --org "<YOUR_ORG_ID>" -n "Kickstart Stack"。创建带 preview 作用域并启用 preview token 的 delivery token;在 stack 中启用 Live Preview 并指向 Preview 环境。
运行应用:开发用 npm run dev,打开 http://localhost:3000;本地生产构建用 npm run build 后 npm run start。
Lint:推送前运行 npm run lint;该仓库没有运行 ESLint 的 GitHub Actions 工作流。
CI(GitHub Actions):sca-scan.yml 在 PR 上运行 Snyk 与 contentstack/sca-policy;policy-scan.yml 检查 SECURITY.md 及公开仓库的 license/year;issues-jira.yml 处理 issue 集成。CI 不运行 npm run build 或 npm run lint,除非后续新增工作流,否则由开发者自行负责。
CODEOWNERS:默认审查者为 @contentstack/devex-pr-reviewers(见 .github/CODEOWNERS);安全相关工作流及相关路径可能需要 @contentstack/security-admin。
可选 Talisman:存在 .talismanrc 文件;若本地使用 Talisman 做密钥扫描,请遵循组织指引。
限制:资料未提供价格、平台支持范围或效果说明。