create-tengits-app 1.0.0

package/PUBLISH.md

@@ -0,0 +1,151 @@
+# 发布指南
+
+## 📦 发布到 NPM
+
+### 1. 准备发布
+
+确保所有文件已准备就绪：
+- ✅ `bin/cli.js` - 脚手架入口文件
+- ✅ `package.json` - 包含正确的 bin 配置
+- ✅ `README.md` - 详细的使用说明
+- ✅ `.npmignore` - 排除不必要的文件
+
+### 2. 测试脚手架
+
+在发布前先本地测试：
+
+```bash
+# 测试 CLI 是否正常工作
+node bin/cli.js
+
+# 或者使用 npm 脚本
+npm run test-cli
+```
+
+### 3. 登录 NPM
+
+```bash
+npm login
+```
+
+输入你的 NPM 账号信息。
+
+### 4. 发布包
+
+```bash
+# 检查包信息
+npm publish --dry-run
+
+# 正式发布
+npm publish
+```
+
+### 5. 验证发布
+
+发布成功后，可以使用以下方式验证：
+
+```bash
+# 使用 npx 运行
+npx create-tengits-app
+
+# 或全局安装后运行
+npm install -g create-tengits-app
+create-tengits-app
+```
+
+## 🔄 版本更新
+
+### 更新版本号
+
+```bash
+# 补丁版本（bug 修复）
+npm version patch
+
+# 次要版本（新功能）
+npm version minor  
+
+# 主要版本（破坏性更改）
+npm version major
+```
+
+### 重新发布
+
+```bash
+npm publish
+```
+
+## 📋 发布检查清单
+
+发布前请确保：
+
+- [ ] 包名在 NPM 上是唯一的
+- [ ] 版本号已正确更新
+- [ ] README.md 包含完整的使用说明
+- [ ] 所有依赖都已正确配置
+- [ ] .npmignore 文件配置正确
+- [ ] CLI 命令能正常执行
+- [ ] 模板文件完整无误
+- [ ] 许可证信息正确
+- [ ] 作者信息已填写
+- [ ] 仓库 URL 已配置
+
+## 🎯 推广建议
+
+发布后可以考虑：
+
+1. **GitHub Release** - 创建 GitHub Release 并添加更新日志
+2. **社交媒体** - 在 Twitter、LinkedIn 等平台分享
+3. **技术博客** - 写一篇介绍文章
+4. **开发者社区** - 在相关论坛和群组分享
+5. **文档优化** - 不断完善文档和示例
+
+## 📊 监控和维护
+
+### 下载统计
+- 查看 NPM 下载量：https://www.npmjs.com/package/create-tengits-app
+- 使用 npm-stat 等工具监控
+
+### 问题反馈
+- 及时处理 GitHub Issues
+- 回应用户反馈
+- 持续优化模板内容
+
+### 依赖更新
+- 定期更新依赖版本
+- 测试兼容性
+- 发布新版本
+
+## 🚀 自动化发布（可选）
+
+可以配置 GitHub Actions 自动发布：
+
+```yaml
+# .github/workflows/publish.yml
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+## 📝 注意事项
+
+1. **包名唯一性** - 确保包名在 NPM 上没有被占用
+2. **语义化版本** - 遵循 SemVer 规范
+3. **向后兼容** - 避免破坏性更改
+4. **文档维护** - 保持文档与代码同步
+5. **测试充分** - 发布前充分测试各种场景

package/README.md

@@ -0,0 +1,255 @@
+# Create Tengits App
+
+<div align="center">
+
+🚀 **快速创建基于 React + Rsbuild + TypeScript + Tailwind CSS + Antd 的现代前端项目脚手架**
+
+[![NPM version](https://img.shields.io/npm/v/create-tengits-app.svg?style=flat)](https://npmjs.org/package/create-tengits-app)
+[![NPM downloads](https://img.shields.io/npm/dm/create-tengits-app.svg?style=flat)](https://npmjs.org/package/create-tengits-app)
+[![License](https://img.shields.io/github/license/your-username/create-tengits-app.svg)](https://github.com/your-username/create-tengits-app/blob/main/LICENSE)
+
+</div>
+
+## ✨ 特性
+
+- ⚡ **快速构建** - 基于 [Rsbuild](https://rsbuild.dev/) 的极速构建体验
+- ⚛️ **React 18** - 最新的 React 版本，支持并发特性
+- 🔷 **TypeScript** - 完整的类型安全支持
+- 🎨 **Tailwind CSS** - 实用优先的 CSS 框架
+- 🐜 **Ant Design** - 企业级 UI 组件库
+- 🌍 **国际化** - 完整的 i18n 支持（React-i18next）
+- 📱 **响应式设计** - 移动端友好
+- 🔧 **开发工具** - ESLint、PostCSS 等完整工具链
+- 📦 **Monorepo** - 基于 pnpm workspace 的包管理
+- 🎯 **生产就绪** - 开箱即用的生产环境配置
+
+## 🚀 快速开始
+
+### 方式一：使用 npx（推荐）
+
+```bash
+npx create-tengits-app
+```
+
+### 方式二：全局安装
+
+```bash
+# 使用 npm
+npm install -g create-tengits-app
+
+# 使用 yarn
+yarn global add create-tengits-app
+
+# 使用 pnpm
+pnpm add -g create-tengits-app
+
+# 创建项目
+create-tengits-app
+```
+
+### 方式三：一键创建
+
+```bash
+# npm
+npm create react-rsbuild-app
+
+# yarn
+yarn create react-rsbuild-app
+
+# pnpm
+pnpm create react-rsbuild-app
+```
+
+## 📖 使用方法
+
+1. **运行脚手架命令**
+   ```bash
+   npx create-tengits-app
+   ```
+
+2. **输入项目名称**
+   ```
+   请输入项目名称（默认: my-react-app）: my-awesome-project
+   ```
+
+3. **等待项目创建和依赖安装**
+   脚手架会自动：
+   - 创建项目目录
+   - 复制模板文件
+   - 安装项目依赖
+   - 配置项目信息
+
+4. **启动开发服务器**
+   ```bash
+   cd my-awesome-project
+   pnpm start  # 或 yarn start / npm start
+   ```
+
+## 📁 项目结构
+
+生成的项目结构如下：
+
+```
+my-awesome-project/
+├── packages/
+│   └── main/                  # 主应用包
+│       ├── src/
+│       │   ├── components/    # 可复用组件
+│       │   ├── pages/         # 页面组件
+│       │   │   ├── Home/      # 首页
+│       │   │   └── Login/     # 登录页
+│       │   ├── styles/        # 样式文件
+│       │   ├── types/         # TypeScript 类型定义
+│       │   ├── utils/         # 工具函数
+│       │   ├── App.tsx        # 应用主组件
+│       │   ├── index.jsx      # 应用入口
+│       │   ├── routes.tsx     # 路由配置
+│       │   └── menus.jsx      # 菜单配置
+│       ├── public/            # 静态资源
+│       │   ├── locales/       # 国际化文件
+│       │   └── ...
+│       ├── package.json       # 包配置文件
+│       ├── rsbuild.config.ts  # Rsbuild 配置
+│       ├── tailwind.config.js # Tailwind 配置
+│       └── tsconfig.json      # TypeScript 配置
+├── pnpm-workspace.yaml        # pnpm workspace 配置
+├── package.json               # 根包配置
+├── eslint.config.mjs          # ESLint 配置
+└── README.md                  # 项目说明
+```
+
+## 🛠️ 可用脚本
+
+在项目目录中，你可以运行：
+
+### `pnpm start`
+启动开发服务器，通常在 [http://localhost:3000](http://localhost:3000) 访问
+
+### `pnpm build`
+构建生产版本到 `dist` 目录
+
+### `pnpm preview`
+预览生产构建版本
+
+### `pnpm doctor`
+检查项目配置和依赖
+
+## 🎨 技术栈
+
+- **构建工具**: [Rsbuild](https://rsbuild.dev/) - 基于 Rspack 的高性能构建工具
+- **前端框架**: [React](https://reactjs.org/) - 用于构建用户界面的 JavaScript 库
+- **类型系统**: [TypeScript](https://www.typescriptlang.org/) - JavaScript 的超集，提供静态类型检查
+- **样式方案**: [Tailwind CSS](https://tailwindcss.com/) - 实用优先的 CSS 框架
+- **UI 组件库**: [Ant Design](https://ant.design/) - 企业级 UI 设计语言和组件库
+- **路由**: [React Router](https://reactrouter.com/) - React 的声明式路由
+- **状态管理**: [React Query](https://tanstack.com/query) - 强大的数据同步库
+- **HTTP 客户端**: [Axios](https://axios-http.com/) - 基于 Promise 的 HTTP 库
+- **国际化**: [React-i18next](https://react.i18next.com/) - React 的国际化框架
+- **包管理**: [pnpm](https://pnpm.io/) - 快速、节省磁盘空间的包管理器
+
+## 🔧 自定义配置
+
+### Rsbuild 配置
+
+编辑 `packages/main/rsbuild.config.ts` 来自定义构建配置：
+
+```typescript
+import { defineConfig } from '@rsbuild/core';
+import { pluginReact } from '@rsbuild/plugin-react';
+
+export default defineConfig({
+  plugins: [pluginReact()],
+  // 你的自定义配置
+});
+```
+
+### Tailwind CSS 配置
+
+编辑 `packages/main/tailwind.config.js` 来自定义样式：
+
+```javascript
+module.exports = {
+  content: ['./src/**/*.{js,ts,jsx,tsx}'],
+  theme: {
+    extend: {
+      // 你的自定义主题
+    },
+  },
+  plugins: [],
+};
+```
+
+### TypeScript 配置
+
+编辑 `packages/main/tsconfig.json` 来调整 TypeScript 设置。
+
+## 🌍 国际化
+
+项目内置了完整的国际化支持：
+
+1. **语言文件位置**: `packages/main/public/locales/`
+2. **支持语言**: 中文、英文、德文、西班牙文、法文
+3. **使用方式**:
+   ```tsx
+   import { useTranslation } from 'react-i18next';
+   
+   const { t } = useTranslation();
+   return <div>{t('welcome')}</div>;
+   ```
+
+## 📦 部署
+
+### 构建项目
+```bash
+pnpm build
+```
+
+### 静态部署
+构建后的文件在 `packages/main/dist` 目录中，可以部署到任何静态文件服务器。
+
+### 环境配置
+项目支持多环境配置：
+- 开发环境: `pnpm start`
+- 测试环境: `pnpm start:test`
+- 预发布环境: `pnpm start:pre`
+- 生产构建: `pnpm build`
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+1. Fork 项目
+2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启 Pull Request
+
+## 📝 更新日志
+
+### v1.0.0
+- 🎉 初始版本发布
+- ✨ 支持 React 18 + Rsbuild
+- 🎨 集成 Tailwind CSS + Ant Design
+- 🌍 内置国际化支持
+- 📱 响应式设计
+
+## 📄 许可证
+
+[MIT](LICENSE) © [Your Name]
+
+## 🙏 致谢
+
+- [Rsbuild](https://rsbuild.dev/) - 极速的 Web 构建工具
+- [React](https://reactjs.org/) - 用于构建用户界面的 JavaScript 库
+- [Ant Design](https://ant.design/) - 企业级 UI 设计语言
+- [Tailwind CSS](https://tailwindcss.com/) - 实用优先的 CSS 框架
+
+---
+
+<div align="center">
+
+**如果这个项目对你有帮助，请给一个 ⭐️ Star ⭐️**
+
+Made with ❤️ by [Your Name]
+
+</div>

package/USAGE.md

@@ -0,0 +1,154 @@
+# 使用指南
+
+## 快速创建项目
+
+### 1. 运行脚手架
+```bash
+npx create-tengits-app
+```
+
+### 2. 输入项目信息
+```
+🚀 欢迎使用 Tengits 前端脚手架！
+
+请输入项目名称（默认: my-react-app）: my-project
+```
+
+### 3. 等待创建完成
+脚手架会自动完成以下步骤：
+- ✅ 创建项目目录
+- ✅ 复制模板文件
+- ✅ 配置 package.json
+- ✅ 安装项目依赖
+
+### 4. 启动项目
+```bash
+cd my-project
+pnpm start
+```
+
+## 项目特性
+
+生成的项目包含以下特性：
+
+### 🛠️ 技术栈
+- **React 18** - 最新的 React 版本
+- **TypeScript** - 类型安全的 JavaScript
+- **Rsbuild** - 快速的构建工具
+- **Tailwind CSS** - 实用优先的样式框架
+- **Ant Design** - 企业级 UI 组件库
+
+### 🌟 内置功能
+- ✅ 路由系统 (React Router)
+- ✅ 状态管理 (React Query)
+- ✅ 国际化支持 (i18next)
+- ✅ HTTP 请求 (Axios)
+- ✅ 响应式设计
+- ✅ 深色/浅色主题
+- ✅ TypeScript 完整支持
+- ✅ ESLint 代码规范
+- ✅ PostCSS 样式处理
+
+### 📁 目录结构
+```
+my-project/
+├── packages/main/         # 主应用
+│   ├── src/
+│   │   ├── components/    # 可复用组件
+│   │   ├── pages/         # 页面组件
+│   │   ├── utils/         # 工具函数
+│   │   ├── styles/        # 样式文件
+│   │   └── types/         # 类型定义
+│   ├── public/            # 静态资源
+│   ├── rsbuild.config.ts  # 构建配置
+│   └── package.json       # 包配置
+├── pnpm-workspace.yaml    # workspace 配置
+└── package.json           # 根配置
+```
+
+## 开发命令
+
+```bash
+# 启动开发服务器
+pnpm start
+
+# 构建生产版本
+pnpm build
+
+# 预览生产版本
+pnpm preview
+
+# 代码检查
+pnpm doctor
+```
+
+## 环境配置
+
+项目支持多环境配置：
+
+```bash
+# 开发环境（默认）
+pnpm start
+
+# 测试环境
+pnpm start:test
+
+# 预发布环境
+pnpm start:pre
+
+# 生产构建
+pnpm build
+pnpm build:test  # 测试环境构建
+pnpm build:pre   # 预发布环境构建
+```
+
+## 自定义配置
+
+### 修改构建配置
+编辑 `packages/main/rsbuild.config.ts`
+
+### 修改样式主题
+编辑 `packages/main/tailwind.config.js`
+
+### 添加路由
+编辑 `packages/main/src/routes.tsx`
+
+### 配置国际化
+添加语言文件到 `packages/main/public/locales/`
+
+## 部署
+
+### 静态部署
+```bash
+pnpm build
+# 将 packages/main/dist 目录部署到服务器
+```
+
+### Docker 部署
+```dockerfile
+FROM nginx:alpine
+COPY packages/main/dist /usr/share/nginx/html
+EXPOSE 80
+CMD ["nginx", "-g", "daemon off;"]
+```
+
+## 常见问题
+
+### Q: 如何修改项目端口？
+A: 修改 `packages/main/rsbuild.config.ts` 中的 server 配置
+
+### Q: 如何添加新的 UI 组件？
+A: 在 `packages/main/src/components/` 目录下创建新组件
+
+### Q: 如何配置代理？
+A: 在 `packages/main/rsbuild.config.ts` 中添加 proxy 配置
+
+### Q: 如何添加环境变量？
+A: 创建 `.env` 文件或在 rsbuild 配置中定义
+
+## 技术支持
+
+如需帮助，请：
+1. 查看 [官方文档](https://github.com/your-username/create-tengits-app)
+2. 提交 [GitHub Issue](https://github.com/your-username/create-tengits-app/issues)
+3. 参考 [示例项目](https://github.com/your-username/create-tengits-app/tree/main/examples)