Apache ECharts 示例项目教程

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

Apache ECharts 示例项目的目录结构如下：

echarts-examples/
├── config/
│   └── **配置文件**
├── e2e/
│   └── **端到端测试相关文件**
├── src/
│   └── **示例源代码**
├── tool/
│   └── **构建工具**
├── .gitignore
├── .npmignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录介绍：

• config/: 包含项目的配置文件。
• e2e/: 包含端到端测试的相关文件。
• src/: 包含示例的源代码。
• tool/: 包含构建工具和脚本。
• .gitignore: Git 忽略文件。
• .npmignore: npm 忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的脚本命令。以下是一些常用的启动命令：

{
  "scripts": {
    "build:example": "node tool/build-example.js -t default",
    "release": "npm run build:example && npm run copy:build",
    "test:e2e": "node e2e/main.js",
    "test:e2e:esbuild": "node e2e/main.js --esbuild"
  }
}

命令介绍：

• npm run build:example: 构建示例项目，默认使用默认主题。
• npm run release: 构建并复制所有构建资源到 echarts-website 目录。
• npm run test:e2e: 运行端到端测试，使用 webpack。
• npm run test:e2e:esbuild: 运行端到端测试，使用 esbuild，速度更快。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，以下是一些关键的配置文件：

config/example.config.js

该文件包含了示例项目的构建配置，例如主题、资源路径等。

module.exports = {
  theme: 'default',
  outputDir: 'dist',
  resourcePath: 'src/resources'
};

e2e/config.js

该文件包含了端到端测试的配置，例如依赖仓库、测试路径等。

module.exports = {
  repos: [
    'https://github.com/apache/echarts.git',
    'https://github.com/apache/echarts-website.git'
  ],
  testPath: 'e2e/tests'
};

通过这些配置文件，可以灵活地调整项目的构建和测试行为。

---

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