WooCommerce Admin 开源项目指南

WooCommerce Admin 开源项目指南

woocommerce-admin (Deprecated) This plugin has been merged to woocommerce/woocommerce 项目地址: https://gitcode.com/gh_mirrors/wo/woocommerce-admin

1. 目录结构及介绍

WooCommerce Admin 是一个专为提供现代、JavaScript 驱动的 WooCommerce 管理体验而设计的功能插件。自 2024 年7月12日之后，此仓库已被归档，其功能已合并至主 WooCommerce 插件中。尽管如此，我们可以通过历史版本来了解其结构。

• 根目录:

  • src-internal/Admin: 包含核心Admin相关的JavaScript代码。
  • src: 更广泛地包含了其他JavaScript资源。
  • client: 客户端应用的特定代码。
  • config 和 includes: 存放配置文件和一些通用代码片段。
  • docker, images, languages: 分别支持Docker环境、图片资源和多语言文件。
  • node_modules, vendor: 编译依赖（安装后生成）和PHP依赖库。
  • tests, storybook: 测试脚本与组件故事书，用于UI组件测试和展示。

• 关键文件:

  • composer.json, composer.lock: PHP依赖管理和锁定文件。
  • package.json, pnpm-lock.yaml: JavaScript依赖和PNPM锁文件。
  • webpack.config.js: 打包编译配置文件。
  • Gruntfile.js (虽然提到但在归档时可能不再使用): 早期构建工具配置。
  • LICENSE.md, README.md: 许可协议和项目快速入门指南。

2. 项目启动文件介绍

在进行本地开发前，需先确保满足预置条件，包括安装WordPress 5.6及以上和WooCommerce 5.7.0或更高版本。主要的启动流程涉及JavaScript和PHP环境的准备：

• 启动命令:

  • 使用 pnpm install 安装JavaScript依赖。
  • 运行 composer install 来处理PHP依赖。

  对于开发模式，执行 pnpm run dev 将启动开发服务器，实时编译并监听文件变化，适用于快速迭代。

• 构建与打包:

  • 生产环境部署前，使用 pnpm run build 生成压缩过的生产环境代码。
  • 若要创建一个可用于上传的WordPress插件ZIP文件，运行 pnpm run build:release。

3. 项目的配置文件介绍

• WordPress配置要求:

  • 在wp-config.php添加 define('SCRIPT_DEBUG', true); 可以加载未压缩的库文件，便于调试React等前端库的开发版本。

• 项目内部配置:

  • config/config.php 可能包含插件的特定配置，但具体路径和命名可能有变，因实际归档后的仓库细节不详。
  • 对于开发设置，.env 文件通常用来存放环境变量，但在提供的资料中并未直接提及，需根据实际开发环境配置。
  • package.json 和 composer.json 间接作为配置文件，定义了项目依赖和脚本命令。

请注意，由于该仓库已被归档，具体的配置文件名或位置可能会有所差异，并且对于最新的使用方法应参考合并到 WooCommerce 主仓库的最新文档。以上信息基于归档前的信息概述。

woocommerce-admin (Deprecated) This plugin has been merged to woocommerce/woocommerce 项目地址: https://gitcode.com/gh_mirrors/wo/woocommerce-admin