Skip to content

Meow642/create-ai-fullstack

Repository files navigation

create-ai-fullstack

一键创建面向 AI 编码代理优化的 pnpm 全栈 monorepo 模板。

生成的项目内置共享 Zod 契约、Express API、React 前端、OpenAPI YAML 契约、OpenAPI 文档站,以及可端到端运行的 items CRUD + WebSocket 通知 demo。

快速开始

pnpm dlx create-ai-fullstack my-app
cd my-app
pnpm dev

本地试跑模板

开发 CLI 时,可以不发 npm 包,直接用当前仓库生成一个临时项目并启动前后端:

pnpm dev:template

该命令会:

  • 构建当前 CLI。
  • 清空 /tmp/create-ai-fullstack-dev
  • /tmp/create-ai-fullstack-dev/app 生成模板项目。
  • 执行 pnpm install
  • 启动生成项目的 pnpm dev

可通过 CAF_DEV_TMP 覆盖临时目录:

CAF_DEV_TMP=/tmp/my-caf-run pnpm dev:template

生成内容

  • apps/api:Express 5、SQLite(可选 better-sqlite3 或 sql.js)、ws、Zod 校验、Scalar API 文档。
  • apps/web:Vite 8、React 19、Tailwind v4、shadcn/ui、TanStack Query。
  • packages/shared:共享 Zod schemas、推导类型、OpenAPI registry。
  • api-contracts/api/openapi.yaml:从共享 schema 自动生成并纳入版本控制的机器契约。
  • prompts/docs/contracts.mddocs/bdd-scenarios.md:符合 AI 团队规范的 prompt 与契约文档入口。
  • docker-compose*.yml.github/workflows/ci.yml:生成项目默认包含 Compose 与 CI 护栏。

AI 工具兼容性

生成项目使用 AGENTS.md 作为 AI 编码代理指引的单一事实源,并保留 CLAUDE.md pointer 兼容 Claude Code。

项目指引原生或通过 fallback 支持:

  • Claude Code
  • Codex
  • OpenCode
  • Cursor
  • Windsurf

当前 scaffold 只生成通用项目指引,不预置项目级 skills 或子 agent。后续任务调度入口会在 C 阶段重新设计,避免旧版 full-dev-flow 与新调度机制互相干扰。

开发地址

  • 前端页面:http://localhost:5173/items
  • API 文档:http://localhost:3000/docs
  • 机器契约:http://localhost:3000/openapi.yaml
  • 健康检查:http://localhost:3000/health

CLI 参数

create-ai-fullstack [dir] [--no-install] [--no-git] [--db better-sqlite3|sql-js]
  • [dir]:目标项目目录。传入时项目名默认使用目录名。
  • --no-install:只生成文件,不自动执行 pnpm install
  • --no-git:不初始化 git 仓库。
  • --db:跳过交互式数据库驱动选择。默认 sql-js,不需要本机编译,Windows 和本地 demo 更稳;better-sqlite3 更快、适合服务端部署。

环境要求

  • Node.js >=22.12.0
  • pnpm >=10.33.0

当前版本只支持 pnpm,不会询问包管理器。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors