关于 supastarter-nextjs-skill
面向 supastarter Next.js 的开发技能,为基于该模板构建和维护 SaaS 应用提供技术栈、结构与实现指引。涵盖从数据库和 API 到 UI、部署及排错的专题参考,并附带 API 模块生成脚本。
主要功能
- 01提供 Next.js 专属开发指导
- 02涵盖数据库、API 与 UI 实现
- 03按专题提供参考文档
- 04附带 API 模块生成脚本
- 05包含完整功能开发示例
适用场景
- 01为应用添加数据库和 API 功能
- 02排查配置或部署问题
- 03定制 UI、认证或支付
- 04生成 API 模块骨架
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ oscardrt/ supastarter-nextjs-skill --skill supastarter-nextjs-skill安装后在 Claude Code 中输入/supastarter-nextjs-skill确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
assets/env.exampleassets/recipes/feedback-widget.mdreferences/ai-patterns.mdanalytics.mdapi-patterns.mdauth-patterns.mdbackground-tasks.mdcode-patterns.mdcoding-conventions.mdconfiguration.mdcustomization.mddatabase-patterns.mddeployment.mde2e-testing.mdinternationalization.mdmailing-patterns.mdmonitoring.mdorganization-patterns.mdpayments-patterns.mdquick-reference.mdseo.mdsetup.mdstorage-patterns.mdtech-stack.mdtroubleshooting.mdscripts/generate_module.pyREADME.md详细介绍
supastarter for Next.js – 技能
为使用 supastarter Next.js starter kit 构建可用于生产环境的 SaaS 应用提供专家指导。仅限 Next.js;不包含 Vue/Nuxt 内容。
何时使用此技能
在以下情况下使用此技能:
- 构建或修改 supastarter Next.js 应用
- 添加功能(新实体、API 端点、UI、i18n)
- 使用 Prisma、oRPC、Better Auth、Stripe 或 monorepo 结构
- 调试设置、配置、部署或排查问题
- 用户提到 supastarter Next.js、Prisma、oRPC、Better Auth 或相关技术栈主题
高层工作流:新功能
添加功能时,按以下顺序操作:
- Schema – 在
packages/database/prisma/schema.prisma中添加或更新 Prisma 模型;运行迁移。 - Queries – 在
packages/database/prisma/queries/中添加查询函数,并从queries/index.ts导出。 - API – 在
packages/api/modules/<name>/中添加 oRPC procedures(类型、procedures、router);在packages/api/orpc/router.ts中挂载 router。 - UI – 在
apps/web/中添加 React 组件(例如modules/shared/components/);使用 shadcn、TanStack Query、session hooks。 - i18n – 在
packages/i18n/translations/{en,de}.json中添加翻译键。
完整演练:assets/recipes/feedback-widget.md。
项目结构(Next.js Monorepo)
apps/web/ # Next.js app (App Router, app/, components/, config/, lib/)
packages/
api/ # Hono + oRPC (modules/, orpc/router.ts)
auth/ # Better Auth config
database/ # Prisma schema, migrations, queries
i18n/ # Translations
mail/ # React Email templates, providers
storage/ # S3-compatible storage
ui/ # Shared UI (shadcn)
config/ # Shared config
使用 package exports(例如 @repo/api、@repo/database),而不是深层相对导入。
参考资料(渐进式披露)
只加载所需的参考文件。所有路径均相对于技能根目录,且仅深入一层。
编写代码前,请阅读 references/coding-conventions.md。有关可复制粘贴的模式和命令,请使用 references/code-patterns.md 和 references/quick-reference.md。
| 主题 | 文件 |
|---|---|
| 编码规范(首先阅读) | references/coding-conventions.md |
| 代码模式(示例) | references/code-patterns.md |
| 快速参考(命令、路径) | references/quick-reference.md |
| 技术栈 | references/tech-stack.md |
| 设置、安装、依赖 | references/setup.md |
| 环境变量、配置、功能标志 | references/configuration.md |
| 调试、常见问题 | references/troubleshooting.md |
| Prisma schema、迁移、查询 | references/database-patterns.md |
| Hono/oRPC、procedures、router | references/api-patterns.md |
| Better Auth、session、受保护的端点 | references/auth-patterns.md |
| 组织、角色、多租户 | references/organization-patterns.md |
| Stripe、webhooks、订阅 | references/payments-patterns.md |
| AI 功能、模型 | references/ai-patterns.md |
| UI、主题、扩展 | references/customization.md |
| S3 兼容存储、上传 | references/storage-patterns.md |
| 邮件、模板、提供商 | references/mailing-patterns.md |
| i18n、区域设置、翻译 | references/internationalization.md |
| Meta、站点地图、结构化数据 | references/seo.md |
| 部署、生产环境 | references/deployment.md |
| Cron、后台任务 | references/background-tasks.md |
| 分析集成 | references/analytics.md |
| 监控、错误 | references/monitoring.md |
| E2E 测试 | references/e2e-testing.md |
资源
- 环境变量模板:assets/env.example – 环境变量键名和简短注释(不含机密)。
- 完整示例:assets/recipes/feedback-widget.md – 从数据库 → API → UI → i18n 构建一项功能(反馈组件示例)。
脚本
- generate_module.py – 搭建新的 API 模块骨架(类型、过程、路由器)。请参阅 scripts/README.md 或下方的“脚本”部分。
运行方法(在 supastarter monorepo 根目录中):
python scripts/generate_module.py <module-name>
示例:python scripts/generate_module.py feedback 会创建包含 types.ts、procedures/create.ts 和 router.ts 的 packages/api/modules/feedback/。请手动将路由器挂载到 packages/api/orpc/router.ts 中。
约定(摘要)
- 全程使用 TypeScript;对象结构使用接口。
- React 组件使用具名函数导出;优先使用 Server Components;仅在需要时使用
"use client"。 - 表单:react-hook-form + zod;API:在
packages/api/modules/中定义 oRPC 过程。 - 使用
@repo/*包导入;不要在应用代码中实例化 Prisma/Drizzle。 - 使用 pnpm、Biome(格式化/代码检查)、Turbo;Node.js ≥ 20。
编写代码前,请阅读 references/coding-conventions.md。示例和命令请参阅:references/code-patterns.md、references/quick-reference.md、references/customization.md、references/api-patterns.md。
官方文档
- Next.js 文档(仅此):https://supastarter.dev/docs/nextjs
- 下载 .md 格式文档:https://supastarter.dev/nextjs-docs.zip