机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

Mailchimp开放商务（前身为Reaction Commerce）

开放商务网站 | 推特 | 文档 | Discord | 讨论区

Mailchimp Open Commerce 是一个以 API 为先、无头的商业平台，使用 Node.js、MongoDB 和 GraphQL 构建。它与 npm、Docker 和 Kubernetes 兼容。

功能

入门

要开始使用基于 Mailchimp Open Commerce 构建的自己的项目，您可以首先使用我们的新 CLI。CLI 是在 Open Commerce 上进行开发最快捷、最简单的方式。它允许您通过命令行创建和操作 API、管理后台和店面项目。

你需要的东西

• 我们建议安装 nvm
• 14.18.1 ≤ Node 版本 < 16
• Git
• Docker

• Docker Compose

  此外，您需要为系统设置 与 GitHub 的 SSH 认证

安装 CLI

首先通过运行以下命令安装 CLI：

npm install -g reaction-cli

您可以通过运行以下命令来测试它是否生效：

reaction help

创建项目

您可以通过运行以下命令来创建您的开放商务项目：

reaction create-project api <your-project-name>

这将在目录 中创建一个 Open Commerce 项目。完成后，进入项目目录：

cd <your-project-name> 

安装项目依赖项：

npm install 

最后，在开发模式下启动服务器：

reaction develop api

注意：可选地，在项目目录中，你可以发出上述命令而无需说明项目类型，CLI 会检查你的 package.json 中的“projectType”并从中获取。这要求项目本身是使用上面步骤中说明的最新版本的 CLI 构建的。

例如，你可以跳过提到 'api' 而仅使用以下命令：

  reaction develop

这将启动 Open Commerce GraphQL 服务器和 Mongo 服务器。按 Ctrl C 停止。

• 已安装一个示例自定义插件，您应能在日志中看到其输出。（您的示例插件）
• 要基于我们的插件模板添加新插件，请运行：

  reaction create-plugin api <your-plugin-name>

  验证插件是否在 custom-packages 中创建

  cd custom-packages

  cd <your-plugin-name>

  npm install 

  你现在需要返回到根目录：

  cd ../../

  现在你可以运行：

  reaction develop

  此插件将在下一次启动 Open Commerce 时加载。

恭喜！！你已准备好开始使用 Open Commerce 进行开发

查看完整 CLI 指令了解如何创建本地商店前端和管理后台。

请访问完整的安装说明查看如何设置你的商店

API 开发

如果你正在开发核心插件（而不是为你自己的安装开发插件），你应该遵循这些说明

你需要的东西

• pnpm
• Docker
• Docker Compose

安装 PNPM

npm i -g pnpm@7.11.0

克隆并启动源码

git clone https://github.com/reactioncommerce/reaction.git
cd reaction
pnpm install
cp apps/reaction/.env.example apps/reaction/.env

在本地启动带有 Mongo 的开发服务器：

## you must change MONGO_URL in the .env to mongodb://localhost:27017/reaction before start
pnpm run start:dev

在 Docker 上启动带有 MongoDB 的开发服务器

docker-compose up -d
pnpm run start:dev

开发流程

1. 在一个或多个包中进行一些更改。
2. 在同一个 PR 中添加一个变更集。
3. 重复进行更改和添加变更集的流程。
4. Create PR

如何发布

1. 运行 release 操作以创建 Version PR。此 PR 将删除所有 changeset 文件，提升包的版本，并更新 CHANGELOG 文件。
2. 将 Version PR 合并到主干，CircleCI 将把所有包发布到 npm。

预发布流程

1. 所有的 PR 将在触发 PRERELEASE 操作之前合并到 prerelease 分支。
2. 在将 PR 合并到 prerelease 分支之前，请确保所有的变更集已添加。
3. 手动触发 PRERELEASE 操作以创建 Version Packages (next) PR。合并后，变更集/操作将把包的版本提升为 {next-version}-next.{number}，并更新 CHANGELOG 文件。
4. 将 Version Packages (next) PR 合并到 prerelease 分支，操作将把所有包发布到 npm。

参与进来

贡献

:star: 如果你喜欢看到的内容，请在 GitHub 上给我们点星。

发现了 bug、错别字，或者文档不够完善？我们希望你能 提交一个问题 告诉我们可以改进的地方！这个项目使用 commitlint，请使用他们的 提交信息格式。

我们喜欢你的拉取请求！查看我们的 Good First Issue 和 Help Wanted 标签，了解可以处理的好问题。查看我们的 贡献者指南 以获取更多信息

许可协议

Reaction 使用 GNU GPLv3 许可