create-pardx-scaffold 0.1.0

package/template/README.md

@@ -0,0 +1,125 @@
+# PardxAI Monorepo Scaffold (Full Version)
+
+A comprehensive production-ready monorepo scaffold with complete implementations.
+
+> **脚手架说明**：本仓库作为脚手架模板，**保留除日志（logs）外的全部文件**。`logs/` 目录及 `*.log` 等日志文件已通过 `.gitignore` 排除，不会进入版本库；clone 或基于本仓库创建新项目时，不会包含任何日志文件。详见 [docs/脚手架说明.md](./docs/脚手架说明.md)。
+
+## 🏗️ Architecture
+
+- **Monorepo**: pnpm workspaces + Turborepo
+- **Frontend**: Next.js 16 (App Router) + React 19
+- **Backend**: NestJS 11 + Fastify + Prisma
+- **Shared Packages**: Type-safe code sharing
+
+## 📦 What's Included
+
+### Backend Libs (Complete)
+- ✅ **auth** - Authentication module (JWT, OAuth)
+- ✅ **clients** - External API clients
+- ✅ **common** - Common utilities, decorators, interceptors
+- ✅ **config** - Configuration management
+- ✅ **db** - Database layer
+- ✅ **i18n** - Internationalization
+- ✅ **jwt** - JWT token management
+- ✅ **prisma** - Prisma ORM module
+- ✅ **rabbitmq** - Message queue
+- ✅ **redis** - Cache layer
+- ✅ **services** - Business services (email, file-storage, sms, uploader, etc.)
+- ✅ **utils** - Utility functions
+
+### Database Models (Core)
+- ✅ UserInfo, Auth models (Wechat, Google, Discord, Mobile, Email)
+- ✅ Notification system
+- ✅ Task management
+- ✅ File upload system
+- ✅ Points and rewards
+- ✅ And more...
+
+### Frontend (Complete)
+- ✅ API client with React Query
+- ✅ Providers (Auth, Theme, etc.)
+- ✅ Hooks
+- ✅ i18n setup
+- ✅ Stores
+
+## 🚀 Quick Start
+
+### 1. Initialize Project
+
+\`\`\`bash
+node scripts/init-project.js
+\`\`\`
+
+### 2. Install Dependencies
+
+\`\`\`bash
+pnpm install
+\`\`\`
+
+### 3. Setup Database
+
+\`\`\`bash
+# Generate Prisma client
+pnpm db:generate
+
+# Run migrations
+pnpm db:migrate:dev
+\`\`\`
+
+### 4. Start Development
+
+\`\`\`bash
+# Start all apps
+pnpm dev
+
+# Or individually
+pnpm dev:web  # Frontend
+pnpm dev:api  # Backend
+\`\`\`
+
+## 📝 Environment Variables
+
+### Frontend (.env.local)
+\`\`\`
+NEXT_PUBLIC_API_BASE_URL=http://localhost:3100/api
+\`\`\`
+
+### Backend (.env)
+\`\`\`
+NODE_ENV=development
+DATABASE_URL=postgresql://user:password@localhost:5432/dbname
+REDIS_URL=redis://localhost:6379
+RABBITMQ_URL=amqp://localhost:5672
+JWT_SECRET=your-secret-key
+\`\`\`
+
+## 🛠️ Available Commands
+
+\`\`\`bash
+# Development
+pnpm dev              # Start all apps
+pnpm dev:web          # Start frontend
+pnpm dev:api          # Start backend
+
+# Build
+pnpm build            # Build all apps
+
+# Database
+pnpm db:generate      # Generate Prisma client
+pnpm db:migrate:dev   # Run migrations
+pnpm db:push          # Push schema changes
+
+# Lint & Test
+pnpm lint             # Lint all
+pnpm type-check       # Type check
+pnpm test             # Run tests
+\`\`\`
+
+## 📚 Documentation
+
+- **脚手架范围与排除项**：[docs/脚手架说明.md](./docs/脚手架说明.md)（保留除 logs 外的全部文件）
+- 其它文档：`apps/api/docs/`、各子项目 README
+
+## 📄 License
+
+MIT License

package/template/apps/api/.env.example

@@ -0,0 +1,11 @@
+# postgreSQL
+BASE_HOST=127.0.0.1
+DATABASE_URL=postgresql://pardx:pG8k4M2nX9vL@127.0.0.1:5432/front_scaffold?schema=public&timezone=Asia/Shanghai
+READ_DATABASE_URL=postgresql://pardx:pG8k4M2nX9vL@127.0.0.1:5432/front_scaffold?schema=public&timezone=Asia/Shanghai
+REDIS_URL=redis://:dYop914G7k5S@127.0.0.1:6379/2
+RABBITMQ_URL=amqp://pardx:N051Gym68Ul3@127.0.0.1:5672/nestjs_xica
+RABBITMQ_EVENTS_URL="amqp://pardx:N051Gym68Ul3@${BASE_HOST}:5672/nestjs_to_agentx_events"
+
+API_BASE_URL=http://3cc199a8.r10.vip.cpolar/api
+INTERNAL_API_BASE_URL=http://127.0.0.1:3100/api
+

package/template/apps/api/.eslintrc.js

@@ -0,0 +1,222 @@
+// .eslintrc.js
+/**
+ * ESLint 配置 - 包含架构依赖约束规则
+ *
+ * 架构约束说明:
+ * - Controller → Service → Client → External API
+ * - Plugin → Plugin Client → Internal Client (受控)
+ * - Controller → API Service → DB Service → Prisma
+ * - API Service 必须通过 DB Service (@app/db) 访问数据库
+ * - 只有 libs/db 目录可以直接使用 PrismaService
+ *
+ * 禁止的依赖:
+ * - API Service → Prisma (必须通过 DB Service)
+ * - Client → DB/Prisma (Client 不能直接访问数据库)
+ * - Service → Plugin (Service 不能依赖 Plugin)
+ * - Plugin → Service (Plugin 不能依赖业务 Service)
+ */
+module.exports = {
+    root: true,
+    env: {
+        node: true,
+        jest: true,
+        es2021: true,
+    },
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        project: 'tsconfig.json',
+        tsconfigRootDir: __dirname,
+        sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint/eslint-plugin', 'import'],
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:import/recommended',
+        'plugin:import/typescript',
+        'plugin:prettier/recommended',
+    ],
+    settings: {
+        'import/resolver': {
+            typescript: {
+                alwaysTryTypes: true,
+                project: './tsconfig.json',
+            },
+        },
+    },
+    ignorePatterns: ['.eslintrc.js', 'dist', 'node_modules'],
+    rules: {
+        // ============================================
+        // TypeScript 规则
+        // ============================================
+        '@typescript-eslint/interface-name-prefix': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-unused-vars': 'warn',
+        '@typescript-eslint/no-namespace': 'off',
+        '@typescript-eslint/no-require-imports': 'off',
+        '@typescript-eslint/ban-ts-comment': 'warn',
+        '@typescript-eslint/no-unused-expressions': 'warn',
+        'no-prototype-builtins': 'warn',
+        'no-case-declarations': 'warn',
+        'prefer-const': 'warn',
+        'no-useless-catch': 'warn',
+        'no-unsafe-optional-chaining': 'warn',
+        'no-empty': 'warn',
+
+        // ============================================
+        // 架构依赖约束规则
+        // ============================================
+        'import/no-restricted-paths': [
+            // 初始阶段使用 'warn'，稳定后改为 'error'
+            'warn',
+            {
+                zones: [
+                    // ===========================================
+                    // 规则 1: Client 层禁止直接访问 DB 层
+                    // ===========================================
+                    {
+                        target: './libs/*-client/**/*',
+                        from: './libs/db/**/*',
+                        message:
+                            '[架构违规] Client 层禁止直接访问 DB 层。\n' +
+                            '请将数据访问逻辑移至 Service 层，Client 只负责外部 API 调用。\n' +
+                            '参考: apps/api/docs/Client层重构与Plugin系统设计.md',
+                    },
+
+                    // ===========================================
+                    // 规则 2: Client 层禁止直接访问 Prisma
+                    // ===========================================
+                    {
+                        target: './libs/*-client/**/*',
+                        from: './libs/prisma/**/*',
+                        message:
+                            '[架构违规] Client 层禁止直接访问 PrismaService。\n' +
+                            '请将数据访问逻辑移至 Service 层，Client 只负责外部 API 调用。\n' +
+                            '参考: apps/api/docs/Client层重构与Plugin系统设计.md',
+                    },
+
+                    // ===========================================
+                    // 规则 3: 未来 Plugin 系统规则 (预留)
+                    // ===========================================
+                    // Plugin 禁止访问 API Service
+                    {
+                        target: './src/plugins/**/*',
+                        from: './src/modules/**/*',
+                        message:
+                            '[架构违规] Plugin 禁止直接访问 API Service。\n' +
+                            '请通过 Plugin Client Facade 访问平台能力。',
+                    },
+
+                    // Plugin 禁止直接访问 Internal Client
+                    {
+                        target: './src/plugins/**/*',
+                        from: './libs/*-client/**/*',
+                        except: ['./libs/clients/plugin/**/*'],
+                        message:
+                            '[架构违规] Plugin 只能通过 Plugin Client Facade 访问能力。\n' +
+                            '禁止直接使用 Internal Client。',
+                    },
+
+                    // Plugin 禁止访问 DB 层
+                    {
+                        target: './src/plugins/**/*',
+                        from: './libs/db/**/*',
+                        message: '[架构违规] Plugin 禁止直接访问 DB 层。',
+                    },
+
+                    // Plugin 禁止访问 Prisma
+                    {
+                        target: './src/plugins/**/*',
+                        from: './libs/prisma/**/*',
+                        message:
+                            '[架构违规] Plugin 禁止直接访问 PrismaService。',
+                    },
+
+                    // ===========================================
+                    // 规则 4: API Service 层禁止直接访问 Prisma
+                    // 必须通过 DB Service (@app/db) 访问数据库
+                    // ===========================================
+                    {
+                        target: './src/modules/**/*',
+                        from: './libs/prisma/**/*',
+                        message:
+                            '[架构违规] API Service 层禁止直接访问 PrismaService。\n' +
+                            '请通过 DB Service (@app/db) 访问数据库。\n' +
+                            '跨服务事务请使用 UnitOfWorkService。\n' +
+                            '参考: apps/api/docs/架构分层与事务管理方案-new.md',
+                    },
+
+                    // ===========================================
+                    // 规则 5: libs 下非 db/prisma 目录禁止访问 Prisma
+                    // 只有 libs/db 和 libs/prisma 可以使用 Prisma
+                    // ===========================================
+                    {
+                        target: './libs/auth/**/*',
+                        from: './libs/prisma/**/*',
+                        message:
+                            '[架构违规] 此目录禁止直接访问 PrismaService。\n' +
+                            '请通过 DB Service (@app/db) 访问数据库。',
+                    },
+                    {
+                        target: './libs/permission/**/*',
+                        from: './libs/prisma/**/*',
+                        message:
+                            '[架构违规] 此目录禁止直接访问 PrismaService。\n' +
+                            '请通过 DB Service (@app/db) 访问数据库。',
+                    },
+                    {
+                        target: './libs/services/**/*',
+                        from: './libs/prisma/**/*',
+                        message:
+                            '[架构违规] 此目录禁止直接访问 PrismaService。\n' +
+                            '请通过 DB Service (@app/db) 访问数据库。',
+                    },
+                ],
+            },
+        ],
+
+        // 禁用未使用的 import 检查 (typescript-eslint 已处理)
+        'import/no-unresolved': 'off',
+    },
+
+    // ============================================
+    // 目录特定规则 (overrides)
+    // ============================================
+    overrides: [
+        // ===========================================
+        // 规则: 非 libs/db 目录禁止直接使用 prisma.write/read
+        // ===========================================
+        {
+            files: [
+                'src/modules/**/*.ts',
+                'libs/auth/**/*.ts',
+                'libs/permission/**/*.ts',
+                'libs/services/**/*.ts',
+                'libs/*-client/**/*.ts',
+            ],
+            rules: {
+                'no-restricted-syntax': [
+                    'warn',
+                    {
+                        selector:
+                            'MemberExpression[object.object.type="ThisExpression"][object.property.name="prisma"][property.name=/^(write|read)$/]',
+                        message:
+                            '[架构违规] 禁止直接使用 this.prisma.write 或 this.prisma.read。\n' +
+                            '请通过 DB Service (@app/db) 访问数据库，或使用 getWriteClient()/getReadClient()。\n' +
+                            '参考: apps/api/docs/架构分层与事务管理方案-new.md',
+                    },
+                    {
+                        selector:
+                            'MemberExpression[object.property.name="prisma"][property.name=/^(write|read)$/]:not([object.object.type="ThisExpression"])',
+                        message:
+                            '[架构违规] 禁止直接使用 prisma.write 或 prisma.read。\n' +
+                            '请通过 DB Service (@app/db) 访问数据库。\n' +
+                            '参考: apps/api/docs/架构分层与事务管理方案-new.md',
+                    },
+                ],
+            },
+        },
+    ],
+};