create-codeforge-app 1.0.1 → 1.0.3

package/README.md

@@ -8,16 +8,72 @@
 npx create-codeforge-app my-project
 ```
 
-## 前置条件
+## 新电脑环境准备
 
-- Node.js 20+
-- PostgreSQL 或 Docker（二选一）
+只需要装两样东西：
+
+### 1. 安装 Node.js
+
+```bash
+# macOS
+brew install node
+
+# Windows
+# 去 https://nodejs.org 下载安装
+```
+
+### 2. 安装 PostgreSQL（二选一）
+
+```bash
+# 方式A：直接装（推荐）
+# macOS
+brew install postgresql@16
+brew services start postgresql@16   # 启动服务（只需执行一次，开机自动启动）
+
+# 方式B：用 Docker
+# macOS
+brew install --cask docker
+# 装完打开 Docker Desktop
+# Windows → 去 https://docker.com 下载安装
+```
+
+> 💡 `brew services start` 只需执行一次，之后每次开机 PostgreSQL 会自动启动。如果遇到"PostgreSQL 未启动"的提示，执行 `brew services start postgresql@16` 即可。
+
+### 3. 创建项目
+
+```bash
+npx create-codeforge-app my-shop
+# 回答 4 个问题，等 1-2 分钟，自动完成
+```
+
+不需要登录 npm，不需要 clone 仓库，`npx` 自动下载工具并执行。
 
 ## 功能
 
 - 交互式配置（项目名/标题/数据库名）
 - 自动检测 PostgreSQL / Docker 环境
+- macOS brew 安装的 PostgreSQL 自动识别用户名
 - 可选移动端 H5 骨架
 - 可选删除示例模块
 - 自动安装依赖、初始化数据库、写入种子数据
 - 生成随机 JWT_SECRET
+- 清理 git 历史，干净的 init commit
+
+## 创建完成后
+
+```bash
+cd my-shop
+cd server && npm run start:dev    # 后端 http://localhost:3000
+cd client && npm run dev          # 前端 http://localhost:5173
+
+# 管理员账号: admin@example.com / admin123
+# Swagger 文档: http://localhost:3000/api-docs
+```
+
+## 开发教程
+
+项目创建后参考以下文档：
+
+- `TUTORIAL.md` — 新增业务模块的完整教程（5 步流程）
+- `DEVELOP.md` — 本地开发环境搭建 + 代码规范
+- `DEPLOY.md` — 部署指南（服务器 / Railway / Cloudflare Pages）

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-codeforge-app",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "一行命令创建全栈项目（NestJS + Vue3 + PostgreSQL）",
   "bin": {
     "create-codeforge-app": "./index.js"