# @fleetbase/storefront-engine 中文文档

规范地址：https://npmcn.com/package/%40fleetbase/storefront-engine/

版本：0\.4\.31
npm 元数据更新时间：2026-11-02T11:24:27.153Z
中文译文更新时间：2026-11-14T22:18:42.481Z
软件包许可：AGPL-3\.0-or-later

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fleetbase/storefront-engine
原文对照：https://npmcn.com/package/%40fleetbase/storefront-engine/?lang=original
项目主页：https://github.com/fleetbase/storefront#readme
源码仓库：https://github.com/fleetbase/storefront

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.3 MB，1446 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>= 18
- 运行依赖：14 个
- peer 依赖：ember-engines ^0\.9\.0
- 首次发布：2023-05-17T09:46:37.431Z
- 最新版本发布：2026-11-02T11:24:26.837Z
- 近 30 天下载量：4691（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：95（近 12 个月 25 个）

## 中文简介

车队基地无头商业和市场扩展

## 安装

```sh
npm install @fleetbase/storefront-engine
```

也可以使用：`pnpm add @fleetbase/storefront-engine`、`yarn add @fleetbase/storefront-engine`、`bun add @fleetbase/storefront-engine`

## README

![Fleetbase Storefront](https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/storefront-logo.svg)

后勤-第一无头商业和车队基地的市场基础设施.

[文档](https://www.fleetbase.io/docs/storefront) | [GitHub 图像](https://github.com/fleetbase/storefront) | [平台概况](https://www.fleetbase.io/platform/storefront) | [舰队基地](https://www.fleetbase.io/) | [**用 AppHelm 启动**](https://apphelm.fleetbase.io/storefront?utm_source=github&utm_medium=readme&utm_campaign=launch&utm_content=storefront)

![License: AGPL-3.0-or-later](https://img.shields.io/badge/license-AGPL--3.0--or--later-blue) [![Coverage](https://codecov.io/gh/fleetbase/storefront/branch/main/graph/badge.svg)](https://codecov.io/gh/fleetbase/storefront) ![PHP ^8.0](https://img.shields.io/badge/php-%5E8.0-777bb4) ![Node >=18](https://img.shields.io/badge/node-%3E%3D18-339933) ![Ember Engine](https://img.shields.io/badge/ember-engine-e04e39)

* * *

![Fleetbase Storefront dashboard](https://www.fleetbase.io/images/screenshots/storefront/storefront-dashboard.webp)

## 概览

Storefront是Fleet基地的商业扩展. 它将Laravel API软件包和为Fleetbase Console设计的Ember引擎结合起来,为运营商提供管理商店、产品、推车、退货、客户、市场网络以及实现一个物流-本土系统的工作流程的工具.

与通用的电子商务插件不同,Storefront是围绕从购买到交付的交接而建造的. 取出可以创建Fleet-Ops订单,附加存储前置订单元数据,在Fleet Base Console中暴露客户和商业细节,并保持运营商接近实际交付生命周期.

阅读官方指南 [车队基地.io/docs/商店](https://www.fleetbase.io/docs/storefront)。 。 。 .

## 特征

-   **储存和市场管理**:运行一个单一的商店或将许多商店组织入Storefront网络.
-   **产品目录**:管理产品,类别,变种,变种选项,加成,加成类别,图像,定价,标签,以及可用时间.
-   **地点和移动商务**:配置仓库位置,服务区,餐车,车队-Ops车辆连接,以及分配给移动商店的目录.
-   **货物和退货**:支持持久性推车,行项,变体,加成,排行项目,服务引文,出站初始化,并抓取订单.
-   **付款**:通过Storefront网关配置花纹、QPay和送出现金流.
-   **客户**:支持客户注册,登录,短信验证,社交登录钩,保存客户元数据,设备注册,订单历史,以及账户关闭流量.
-   **命令和履行**:管理控制台的Storefront订单,提前订单活动,指派/不指定驱动程序,标记准备状态,完成接货,并检查与路线和跟踪数据相配套的商业细节.
-   **审查和表决**:曝光API资源供客户审查和投票.
-   **晋升和通知**:管理通知频道,并通过APN、FCM以及相关的Storefront通知类发送广播或交易推动通知.
-   **盘形板分析**: 船舶 Storefront 部件,用于收入,订单量,平均订单值,活订单,完成订单,客户,推车转换,取消率,收入趋势,顶级产品,客户见解,订单状态组合,近期订单,以及近期客户.
-   **舰队-Ops集成**:在Fleet-Ops订单细节内注册 Storefront摘要,并给Fleet-Ops订单创建添加产品-实体工具.
-   **国际化**:通过扩展翻译文件包含多个地语的翻译.

## 客户应用

<table><tbody><tr><td><a href="https://bayfront-pharmacy.apphelm.io/" rel="nofollow noopener noreferrer"><img alt="A marketplace home: featured stores, categories and stores near the customer" src="https://fleetbase.io/images/screenshots/storefront-app/ios/storefront-app-network-details.webp" width="100%" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a></td><td><p>这个 <a href="https://github.com/fleetbase/storefront-app" rel="nofollow noopener noreferrer">存储前端 App</a> 是此扩展的开源客户端应用程序,用于iOS,Android,以及网络. 客户浏览、订购、支付和跟踪其中的交货情况,通过 <a href="https://npmcn.com/package/%40fleetbase/storefront-engine/#readme-public-storefront-api" rel="nofollow noopener noreferrer">公共存储前端 API</a>。 。 。 .</p><p><strong>发射最简单的方法是 <a href="https://apphelm.fleetbase.io/storefront?utm_source=github&amp;utm_medium=readme&amp;utm_campaign=launch&amp;utm_content=storefront" rel="nofollow noopener noreferrer">舰队基地 AppHelm</a></strong>,它把一个Fleetbase商店 出版 作为自己的品牌应用程序, 没有代码可写。 连接你的商店,设置你的品牌, 并预览应用程序与你真正的产品。 在网络上免费发布 <code>yourstore.apphelm.io</code>,然后继续使用 App Store 和 Google Play: AppHelm 从自己的 Apple 和 Google 开发商账户中走遍每个商店的要求并处理构建和提交.</p><p><a href="https://apphelm.fleetbase.io/storefront?utm_source=github&amp;utm_medium=readme&amp;utm_campaign=launch&amp;utm_content=storefront" rel="nofollow noopener noreferrer"><img alt="Launch with AppHelm" src="https://img.shields.io/badge/Launch%20with%20AppHelm-1C6CC7?style=for-the-badge" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a> <a href="https://bayfront-pharmacy.apphelm.io/" rel="nofollow noopener noreferrer"><img alt="See it in action" src="https://img.shields.io/badge/See%20it%20in%20action-24292F?style=for-the-badge" loading="lazy" decoding="async" referrerpolicy="no-referrer"></a></p><p><a href="https://github.com/fleetbase/storefront-app" rel="nofollow noopener noreferrer">源代码</a> • 妇女 <a href="https://github.com/fleetbase/storefront-app#quick-start" rel="nofollow noopener noreferrer">自己盖</a></p></td></tr></tbody></table>

## 建筑

此寄存器包含 Storefront 扩展的两侧 :

| 区域 | 路径 | 目的 |
| --- | --- | --- |
| Ember 引擎 | `addon/`, (中文(简体) ), `app/`, (中文(简体) ), `config/`, (中文(简体) ), `translations/` | Fleetbase Console UI,路线,模型,组件,服务,部件,以及翻译. |
| 拉维尔 API | `server/src/`, (中文(简体) ), `server/config/`, (中文(简体) ), `server/migrations/` | 存储前端 API 控制器,模型,资源,中间软件,提供者,观察者,通知,任务,和数据库迁移. |
| 测试 | `tests/`, (中文(简体) ), `server/tests/` | Ember集成测试和后端测试脚手架. |

Ember 软件包以 `@fleetbase/storefront-engine`。 Laravel 软件包作为 `fleetbase/storefront-api`。 。 。 .

## 控制台模块

存储前端在 `storefront` 路线和揭露这些主要工作领域:

-   **盘子**: 存储前置操作和分析部件.
-   **产品**:产品目录,类别,变体,加成,进口加工,和产品实体创建.
-   **命令**: 收到的库存订单、活动行动、客户细节、商业摘要、文件、路线/跟踪背景和评论.
-   **客户**:客户记录和订单历史.
-   **网络**:多商店市场网络,商店任务,类别,邀请,以及商店,客户,订单的网络级浏览.
-   **目录**:产品捆绑和目录类别,包括食品卡车目录任务.
-   **食品卡车**:车队-Ops车辆连通的有服务区和区支持的移动商店.
-   **晋升**:推动通知运动和通知渠道工作流程.
-   **设置**:存储配置文件,API密钥,位置,网关,以及通知.

## API 表面

Storefront曝光了两个API家庭.

### 公共存储前端 API

公众顾客的API在下面挂起 `storefront/v1` 并由 Storefront API 中间软件保护. 它包括:

-   存储检索,存储/网络信息,位置,网关,搜索,标签,网络商店.
-   分类、产品、食品卡车、评论和客户信息目录浏览.
-   带有添加,更新,去除,空出,并删除操作的持久推车.
-   服务引用自手推车.
-   取出初始化,状态,抓取,花旗设置意图,花旗支付意图更新,以及QPay抓取回调.
-   客户注册,登录,短信码验证,社交登录端点,设备注册,保存地,客户订单,电话验证,花旗客户助手,以及账户关闭流量.
-   订购皮卡完成和接收生成.

### 采购网合同

公众 `network_...` 已接受的关键用途 `network_stores` 作为其市场授权边界,包括另一公司拥有的会员商店。 市场对策只披露公共 Storefront资源;它们不披露成员客户、内部API密钥或网关证书.

-   `GET storefront/v1/stores` 支持搜索、在线/tag/类别/ID过滤器、评分/年龄/流行/trending/最接近类型、以公尺进行距离过滤以及限制/抵消标记.
-   类别和已公布的产品可归入成员商店。 产品答复包括市场搜索和卡片的公共商家背景.
-   墨盒行物品既保留了商家的身份,也保留了商店所在地的身份. 不同商店的产品和地点的替代被否决.
-   出厂重新验证主动会员,存储可用性,已公布产品,位置所有权,网络多卡政策,支付开始前一卡通货币.
-   网络发送引用解决每个代理商店一个来源,并拒绝丢失、外国或不匹配的地点 `422`。 。 。 .
-   何时 `Customer-Token` 已存在, 它具有权威性; 客户身份证明返回有冲突 `403`。 。 。 .

### 内部控制台 API

保护的内部 API 安装在 `storefront/int/v1`它授权舰队基地控制台,包括:

-   CRUD资源用于订单,客户,商店,储存时间,储存地点,产品,产品小时,变种,变种选项,加成,加成类别,网关,通知渠道,审查,投票,食品卡车,目录,目录类别,目录小时.
-   命令接受、准备、准备、完成、取消和不指定驱动程序的行动.
-   网络动作用于添加商店,去除商店,类别,邀请,以及网络查询.
-   分析概览、收入趋势、订单状况组合、顶级产品和客户见解的终点.
-   计量与行动终点.

## 开始

仓库前端设计用于在舰队基地安装 `fleetbase/core-api` 财务报告和审定财务报表 `fleetbase/fleetops-api` 可用.

### 所需资源

-   前一頁 `^8.0`
-   节点.js `>=18`
-   小时
-   作曲家
-   舰队基地
-   舰队基地 舰队Ops API

### 安装依赖关系

```bash
pnpm install
composer install
```

### 后端软件包

```bash
composer require fleetbase/core-api
composer require fleetbase/fleetops-api
composer require fleetbase/storefront-api
```

### 前端软件包

```bash
pnpm install @fleetbase/storefront-engine
```

## 发展

关于当地舰队基地的全部工作流程,见 [舰队基地开发设置指南](https://www.fleetbase.io/docs/platform/quickstart/development-setup)。该指南涵盖以子模块克隆主寄存器,安装活包源,连接扩展,运行 Console dev 服务器,并在后端更改后重新加载API.

### 在舰队基地使用本地存储前端源

在Fleetbase monorepo内部开发 Storefront时, 从寄存器根运行包链接器, 所以本地 `packages/storefront` 源代码取代 Console 和 API 使用的已出版的 Storefront 包 :

```bash
flb-package-linker enable storefront
flb-package-linker install storefront
```

链接器更新了本地Console和API的开发表. 要检查当前链接状态 :

```bash
flb-package-linker status
flb-package-linker doctor
```

如果链接器尚未安装, 请从 Fleetbase 仓库根安装一次 :

```bash
npm link
```

连接后端包更改后, 重新装入运行中的 API 工人, 所以 Laravel Octane 将 PHP 更改 :

```bash
docker compose exec application php artisan octane:reload
```

对于前端修改,运行开发设置指南所描述的Fleetbase Console Dev服务器;链接到的Ember软件包由dev服务器监视并活重装.

### 软件包命令

本地运行 Ember 引擎 :

```bash
pnpm start
```

构建 Ember 引擎 :

```bash
pnpm build
```

运行前端插图和测试 :

```bash
pnpm lint
pnpm test
pnpm test:ember
```

运行后端检查 :

```bash
composer test:lint
composer test:types
composer test:unit
composer test
```

用 Xdebug 或 PCOV 生成并概括完整的后端 Clover 基线 :

```bash
XDEBUG_MODE=coverage composer test:coverage:clover
composer coverage:summary
```

市场变化 `dev-v0.4.19` 必须保留100%的后端语句覆盖。 在重新确定基线之前,应增加重点成败合同.

## 配置

存储前置配置通过 Laravel 包配置文件和环境变量提供:

-   `server/config/storefront.php`: API 路由, Storefront app 校验设置,数据库连接,以及请求节奏.
-   `server/config/api.php`: Storefront API配置.
-   `server/config/database.connections.php`: Storefront 数据库连接默认值.

重要的环境变量包括:

| 变量 | 目的 |
| --- | --- |
| `STOREFRONT_DB_CONNECTION` | Storefront模型的数据库连接名. |
| `STOREFRONT_BYPASS_VERIFICATION_CODE` | 用于审查账户的全例登录代码 `STOREFRONT_REVIEW_ACCOUNTS` (自办会). 仓库可以打开 [App 审查访问](https://npmcn.com/package/%40fleetbase/storefront-engine/docs/app-review.md) 在他们的环境. |
| `STOREFRONT_REVIEW_ACCOUNTS` | 以逗号分隔的电话号码和签名的电子邮件 `STOREFRONT_BYPASS_VERIFICATION_CODE` 并且从未发送过密码. |
| `STOREFRONT_THROTTLE_REQUESTS_PER_MINUTE` | 每个窗口允许的公共 Storefront API 请求(存储密钥+客户端IP). 默认 `120`。 。 。 . |
| `STOREFRONT_THROTTLE_DECAY_MINUTES` | 公共 Storefront API 节流阀窗口在几分钟内。 默认 `1`。 。 。 . |

关于客户应用程序配置,请参见 [存储前端 App 配置文件](https://www.fleetbase.io/docs/storefront/app/configuration)。 。 。 .

## 文档

-   [存储前期文档](https://www.fleetbase.io/docs/storefront)
-   [产品和目录](https://docs.fleetbase.io/guides/storefront/products/)
-   [订单和离职](https://www.fleetbase.io/docs/storefront/orders/overview)
-   [App 审查访问](https://npmcn.com/package/%40fleetbase/storefront-engine/docs/app-review.md): 让 Apple 和 Google 审查员在商店的应用程序上签名
-   [检查流程](https://www.fleetbase.io/docs/storefront/orders/checkout)
-   [存储位置](https://www.fleetbase.io/docs/storefront/stores/store-locations)
-   [存储前端应用配置](https://www.fleetbase.io/docs/storefront/app/configuration)

## 捐款

Storefront遵循与Fleet基地其余部分相同的审查预期:

-   保持更改小而可审查.
-   保存现有建筑和命名公约.
-   实用时添加或更新测试.
-   在打开拉动请求前运行相关的前端或后端验证命令.
-   对于API行为变化,检查API规格和公共文档是否需要更新.

见 [捐款额](https://npmcn.com/package/%40fleetbase/storefront-engine/CONTRIBUTING.md) 一般性捐款指导.

## 许可证

Fleetbase Storefront是开源软件,根据该软件许可 [AGPL-3.0- 或- 后期](https://npmcn.com/package/%40fleetbase/storefront-engine/LICENSE.md)。 。 。 .

## 常见问题

### @fleetbase/storefront-engine 是什么？

车队基地无头商业和市场扩展

### 如何安装 @fleetbase/storefront-engine？

在项目目录运行 npm install @fleetbase/storefront-engine，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：ember-engines（^0\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fleetbase/storefront-engine 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/fleetbase\_\_storefront-engine 是否存在。

### @fleetbase/storefront-engine 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @fleetbase/storefront-engine 可以商用吗？

@fleetbase/storefront-engine 使用 AGPL-3\.0-or-later 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @fleetbase/storefront-engine 的下载量有多少？

根据 npm 官方下载统计，@fleetbase/storefront-engine 在 2026/10/15 – 2026/11/13 这 30 天内被下载 4,691 次，日均约 156 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fleetbase/storefront-engine 还在维护吗？

最新版本 0\.4\.31 发布于 2026/11/02（13 天前）；至今共发布 95 个版本，其中过去 12 个月发布了 25 个；首次发布于 2023/05/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

