Dub 项目使用教程

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

Dub 项目的目录结构如下：

dub/
├── apps/
│   └── web/
├── github/
│   └── workflows/
├── packages/
├── .gitignore
├── .prettierignore
├── LICENSE.md
├── README.md
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── prettier.config.js
├── turbo.json

目录结构介绍

• apps/: 包含项目的 Web 应用代码。
  • web/: Web 应用的主要代码目录。
• github/: 包含 GitHub Actions 的工作流配置文件。
  • workflows/: 存放 CI/CD 相关的配置文件。
• packages/: 包含项目的包管理文件。
• .gitignore: Git 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• LICENSE.md: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• package.json: 项目的依赖管理文件。
• pnpm-lock.yaml: pnpm 的锁定文件，用于版本控制。
• pnpm-workspace.yaml: pnpm 的工作区配置文件。
• prettier.config.js: Prettier 的配置文件。
• turbo.json: Turborepo 的配置文件。

2. 项目的启动文件介绍

Dub 项目的启动文件主要位于 apps/web 目录下。以下是主要的启动文件：

• apps/web/index.js: Web 应用的入口文件，负责启动应用。
• apps/web/server.js: 服务器的启动文件，负责配置和启动服务器。

启动文件介绍

• index.js: 该文件是 Web 应用的入口文件，通常会调用 server.js 来启动服务器。
• server.js: 该文件负责配置服务器，包括路由、中间件等，并启动服务器。

3. 项目的配置文件介绍

Dub 项目的配置文件主要位于项目根目录下。以下是主要的配置文件：

• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。
• pnpm-workspace.yaml: pnpm 的工作区配置文件，用于管理多个包的依赖关系。
• prettier.config.js: Prettier 的配置文件，用于代码格式化。
• turbo.json: Turborepo 的配置文件，用于管理 monorepo 项目的构建和部署。

配置文件介绍

• package.json: 该文件包含了项目的依赖包、脚本命令等信息。例如：

  {
    "name": "dub",
    "version": "1.0.0",
    "scripts": {
      "start": "node apps/web/index.js",
      "build": "turbo run build"
    },
    "dependencies": {
      "express": "^4.17.1"
    }
  }
  

• pnpm-workspace.yaml: 该文件定义了 pnpm 的工作区，用于管理多个包的依赖关系。例如：

  packages:
    - 'apps/*'
    - 'packages/*'
  

• prettier.config.js: 该文件配置了 Prettier 的代码格式化规则。例如：

  module.exports = {
    semi: true,
    singleQuote: true,
    trailingComma: 'all',
  };
  

• turbo.json: 该文件配置了 Turborepo 的构建和部署规则。例如：

  {
    "pipeline": {
      "build": {
        "dependsOn": ["^build"]
      },
      "test": {
        "dependsOn": ["build"]
      }
    }
  }
  

通过以上配置文件，可以有效地管理和启动 Dub 项目。