Merge pull request #177 from AprilNEA/v3-dev

Author: AprilNEA

.npmrc

@@ -1 +1,4 @@
-public-hoist-pattern[]=*prisma*
+public-hoist-pattern[]=*prisma*
+public-hoist-pattern[]=*@prisma/client*
+
+strict-peer-dependencies=false

.pnpmfile.cjs

@@ -0,0 +1,19 @@
+function hookPrisma(pkg) {
+  if (pkg.name === '@nest-http/prisma') {
+    pkg.version = pkg.dependencies['@prisma/client'];
+  }
+  // if (pkg.name === 'nestjs-prisma') {
+  //   pkg.peerDependencies['@prisma/client'] = '*';
+  //   pkg.devDependencies['@prisma/client'] = undefined;
+  // }
+  // if (pkg.name === 'prisma-extension-pagination') {
+  //   pkg.peerDependencies['@prisma/client'] = '*';
+  // }
+  return pkg;
+}
+
+module.exports = {
+  hooks: {
+    readPackage: hookPrisma,
+  },
+};

docs/src/pages/_meta.json

@@ -1,6 +1,6 @@
 {
   "index": "主页",
-  "install": "安装",
+  "quickstart": "快速开始",
   "upgrade": {
     "title": "升级"
   },

docs/src/pages/index.mdx

@@ -49,7 +49,7 @@ export const Stars = () => {
 这是一个由 [ChatGPT-Next-Web](https://github.com/Yidadaa/ChatGPT-Next-Web) 二次开发的项目。
 
 <Cards>
-  <Card title="安装配置" href="/install" />
+  <Card title="快速开始" href="/quickstart" />
   <Card title="更新日志" href="/upgrade/log" />
 </Cards>
 

docs/src/pages/install.mdx docs/src/pages/quickstart.mdxdocs/src/pages/install.mdx renamed to docs/src/pages/quickstart.mdx

@@ -1,7 +1,6 @@
-import { Callout } from 'nextra/components'
-import { Steps } from 'nextra/components'
+import { Callout, Steps } from 'nextra/components'
 
-## 本地部署
+## 快速开始
 <Callout type="info" emoji="ℹ️">
   **Prerequisite** You should have installed Node.js (version 18.10.0 or
   higher).
@@ -12,7 +11,6 @@ import { Steps } from 'nextra/components'
 
   ```bash
   git clone https://github.com/AprilNEA/ChatGPT-Admin-Web.git
-  git checkout v3
   cd ChatGPT-Admin-Web
   pnpm install
   ```
@@ -61,21 +59,73 @@ import { Steps } from 'nextra/components'
 
   ```
 
-  ### 启动项目
+  设置`REDIS_URL`环境变量，例如：
   ```bash
-  turbo run start
+  export REDIS_URL=redis://localhost:6379/0
   ```
+  > 可通过 Docker 快速启动一个 Redis 数据库
+  >
+  > `docker run -p 6379:6379 -d redis/redis-stack:latest`
 
-  项目默认运行在 `http://localhost:3000`。
-
-  首次打开应自动转跳`http://localhost:3000/install`设置管理员账户和密码，设置成功后即可登录。
 
-</Steps>
+  ### 启动项目
+  ```bash
+  pnpm run start
+  ```
 
+  项目默认运行在 `http://localhost:3000`。
 
+  首次运行项目会自动生成`config.json`, 并导入`DATABASE_URL`和`REDIS_URL`环境变量，后续更改可直接修改`config.json`。
 
+  <Callout type="warning" emoji="👷‍♀️">
+    Dashboard is coming soon.
+  </Callout>
 
+  ~~首次打开应自动转跳`http://localhost:3000/install`设置管理员账户和密码，设置成功后即可登录。~~
 
+</Steps>
 
+## 配置
 
+<Callout type="info" emoji="ℹ️">
+  邮件服务仅 Resend 通过测试。
+  短信服务仅 UniSMS 通过测试。
+  支付服务仅 Xunhu 通过测试。
+</Callout>
 
+```json
+{
+  ...// 自动生成部分
+
+  "openai": {
+    "baseUrl": "https://api.openai.com/v1",
+    "keys": [
+      "fff"
+    ]
+  },
+  "email": {
+    "use": "resend",
+    "domain": "example.com",
+    "resend": {
+      "apiKey": "fff"
+    }
+  },
+  "sms": {
+    "use": "uni",
+    "uni": {
+      "signature": "XX科技",
+      "apiKey": "ffffff"
+    }
+  },
+  "payment": {
+    "use": "xunhu",
+    "xunhu": {
+      "wapName": "XX科技",
+      "appId": "ffffff",
+      "appSecret": "ffffff",
+      "notifyUrl": "https://example.com",
+      "returnUrl": "https://example.com"
+    }
+  }
+}
+```

docs/theme.config.tsx

@@ -1,7 +1,7 @@
 export default {
   logo: <span>ChatGPT Admin Web</span>,
   project: {
-    link: 'https://github.com/ArilNEA/ChatGPT-Admin-Web',
+    link: 'https://github.com/AprilNEA/ChatGPT-Admin-Web',
   },
   sidebar: {
     defaultMenuCollapseLevel: 1,

package.json

@@ -16,6 +16,7 @@
   "scripts": {
     "build": "turbo run build",
     "dev": "turbo run dev --parallel",
+    "start": "turbo run start",
     "lint": "turbo run lint",
     "prettier": "prettier --write .",
     "db:init": "prisma db push && prisma db seed",
@@ -28,7 +29,7 @@
     "ts-node": "latest",
     "turbo": "latest",
     "typescript": "latest",
-    "prisma": "5.5.2"
+    "prisma": "5.6.0"
   },
   "prisma": {
     "schema": "prisma/schema.prisma",
@@ -39,10 +40,12 @@
   },
   "pnpm": {
     "overrides": {
-      "nestjs-prisma>@prisma/client": "workspace:@nest-http/prisma@*",
       "@liaoliaots/nestjs-redis>@nestjs/common": "^10.0.0",
       "@liaoliaots/nestjs-redis>@nestjs/core": "^10.0.0",
       "@liaoliaots/nestjs-redis>@nestjs/terminus": "^10.0.0"
+    },
+    "allowedDeprecatedVersions": {
+      "sourcemap-codec": "1.4.8"
     }
   },
   "packageManager": "[email protected]"

packages/backend/src/app.module.ts

@@ -1,10 +1,10 @@
 import { CustomPrismaModule } from 'nestjs-prisma';
 
-import { RedisModule } from '@liaoliaots/nestjs-redis';
+import { RedisModule, RedisModuleOptions } from '@liaoliaots/nestjs-redis';
 import { Module } from '@nestjs/common';
 import { APP_GUARD } from '@nestjs/core';
 
-import { ConfigModule } from '@/common/config';
+import { ConfigModule, ConfigService } from '@/common/config';
 import { AuthGuard } from '@/common/guards/auth.guard';
 import { JwtModule } from '@/libs/jwt/jwt.module';
 import { AuthModule } from '@/modules/auth/auth.module';
@@ -26,9 +26,18 @@ import { AppService } from './app.service';
       useClass: ExtendedPrismaConfigService,
       isGlobal: true,
     }),
-    RedisModule.forRoot({
-      config: {
-        url: process.env.REDIS_URL,
+    RedisModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (
+        configService: ConfigService,
+      ): Promise<RedisModuleOptions> => {
+        return {
+          readyLog: true,
+          config: {
+            url: configService.get('redis')?.url ?? process.env.REDIS_URL,
+          },
+        };
       },
     }),
     AuthModule,

packages/backend/src/common/config/config.service.ts

@@ -3,22 +3,7 @@ import { join } from 'path';
 
 import { Injectable } from '@nestjs/common';
 
-import { BizException } from '@/common/exceptions/biz.exception';
-
 import { ConfigType, ISettingSchema } from 'shared';
-import { ErrorCodeEnum } from 'shared/dist/error-code';
-
-const DEFAULT_CONFIG = {
-  mode: 'nginx',
-  title: 'ChatGPT Admin Web',
-  port: {
-    frontend: 3000,
-    backend: 3001,
-  },
-  jwt: {
-    algorithm: 'HS256',
-  },
-};
 
 const CONFIG_SCHEMA: ISettingSchema[] = [
   {
@@ -82,15 +67,18 @@ const CONFIG_SCHEMA: ISettingSchema[] = [
 @Injectable()
 export class ConfigService {
   private config: ConfigType;
-  private readonly defaultConfig = DEFAULT_CONFIG;
   private readonly configFilePath = join(__dirname, '../../../config.json');
 
   constructor() {
     this.loadConfig();
   }
 
   private loadConfig(): void {
-    this.config = JSON.parse(fs.readFileSync(this.configFilePath, 'utf8'));
+    if (fs.existsSync(this.configFilePath)) {
+      this.config = JSON.parse(fs.readFileSync(this.configFilePath, 'utf8'));
+    } else {
+      console.error('配置文件缺失。\nConfiguration file is missing.');
+    }
   }
 
   /* 获取配置文件结构 */

packages/backend/src/common/exceptions/biz.exception.ts

@@ -1,6 +1,6 @@
 import { HttpException } from '@nestjs/common';
 
-import { ErrorCodeEnum } from 'shared/dist/error-code';
+import { ErrorCodeEnum } from 'shared';
 
 export const ErrorCode = Object.freeze<
   Record<ErrorCodeEnum, [string, string, number]>
@@ -84,7 +84,9 @@ export const ErrorCode = Object.freeze<
   [ErrorCodeEnum.DatabaseError]: ['Database error', '数据库错误', 500],
   [ErrorCodeEnum.RedisError]: ['Redis error', 'Redis错误', 500],
   [ErrorCodeEnum.EmailError]: ['Email error', '邮件错误', 500],
+  [ErrorCodeEnum.EmailNotSetup]: ['Email not setup', '邮件未设置', 500],
   [ErrorCodeEnum.SmsError]: ['Sms error', '短信错误', 500],
+  [ErrorCodeEnum.SmsNotSetup]: ['Sms not setup', '短信未设置', 500],
   [ErrorCodeEnum.WechatError]: ['Wechat error', '微信错误', 500],
   [ErrorCodeEnum.UnknownError]: ['Unknown error', '未知错误', 500],
 });