Vendure 开源项目使用教程

1. 项目的目录结构及介绍

Vendure 项目的目录结构如下：

vendure/
├── README.md
├── package.json
├── tsconfig.json
├── src/
│   ├── api/
│   ├── config/
│   ├── core/
│   ├── plugin/
│   ├── worker/
│   └── index.ts
├── dist/
└── node_modules/

• README.md: 项目介绍文档。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• src/: 源代码目录。
  • api/: 包含 GraphQL API 相关代码。
  • config/: 包含项目配置文件。
  • core/: 包含核心业务逻辑代码。
  • plugin/: 包含插件相关代码。
  • worker/: 包含后台任务处理代码。
  • index.ts: 项目入口文件。
• dist/: 编译后的 JavaScript 文件目录。
• node_modules/: 项目依赖包目录。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，该文件主要负责启动 Vendure 服务器。以下是 src/index.ts 的主要内容：

import { bootstrap } from '@vendure/core';
import { config } from './config/vendure-config';

bootstrap(config).catch(err => {
    console.error(err);
});

• bootstrap: 是 Vendure 提供的启动函数。
• config: 是项目的配置对象，定义在 src/config/vendure-config.ts 文件中。

3. 项目的配置文件介绍

项目的配置文件是 src/config/vendure-config.ts，该文件定义了 Vendure 服务器的各种配置选项。以下是 src/config/vendure-config.ts 的主要内容：

import { VendureConfig } from '@vendure/core';
import { defaultEmailHandlers } from '@vendure/email-plugin';
import { AssetServerPlugin } from '@vendure/asset-server-plugin';
import { AdminUiPlugin } from '@vendure/admin-ui-plugin';

export const config: VendureConfig = {
    apiOptions: {
        port: 3000,
        adminApiPath: 'admin-api',
        shopApiPath: 'shop-api',
    },
    authOptions: {
        tokenMethod: ['bearer', 'cookie'],
        superadminCredentials: {
            identifier: 'superadmin',
            password: 'superadminpassword',
        },
    },
    dbConnectionOptions: {
        type: 'postgres',
        synchronize: true,
        logging: true,
        database: 'vendure',
        user: 'postgres',
        password: 'postgres',
    },
    plugins: [
        AssetServerPlugin.init({
            assetUploadDir: path.join(__dirname, '../static/assets'),
        }),
        AdminUiPlugin.init({
            port: 3002,
        }),
        EmailPlugin.init({
            handlers: defaultEmailHandlers,
            templatePath: path.join(__dirname, '../static/email/templates'),
            route: 'mailbox',
            outputPath: path.join(__dirname, '../static/email/test-emails'),
        }),
    ],
};

• apiOptions: 定义 API 的端口和路径。
• authOptions: 定义认证选项，包括 token 方法和超级管理员凭证。
• dbConnectionOptions: 定义数据库连接选项。
• plugins: 定义使用的插件，包括资产服务器插件、管理界面插件和邮件插件。

以上是 Vendure 开源项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 Vendure 项目。