后勤-第一无头商业和车队基地的市场基础设施.
文档 | GitHub 图像 | 平台概况 | 舰队基地 | 用 AppHelm 启动
概览
Storefront是Fleet基地的商业扩展. 它将Laravel API软件包和为Fleetbase Console设计的Ember引擎结合起来,为运营商提供管理商店、产品、推车、退货、客户、市场网络以及实现一个物流-本土系统的工作流程的工具.
与通用的电子商务插件不同,Storefront是围绕从购买到交付的交接而建造的. 取出可以创建Fleet-Ops订单,附加存储前置订单元数据,在Fleet Base Console中暴露客户和商业细节,并保持运营商接近实际交付生命周期.
阅读官方指南 车队基地.io/docs/商店。 。 。 .
特征
- 储存和市场管理:运行一个单一的商店或将许多商店组织入Storefront网络.
- 产品目录:管理产品,类别,变种,变种选项,加成,加成类别,图像,定价,标签,以及可用时间.
- 地点和移动商务:配置仓库位置,服务区,餐车,车队-Ops车辆连接,以及分配给移动商店的目录.
- 货物和退货:支持持久性推车,行项,变体,加成,排行项目,服务引文,出站初始化,并抓取订单.
- 付款:通过Storefront网关配置花纹、QPay和送出现金流.
- 客户:支持客户注册,登录,短信验证,社交登录钩,保存客户元数据,设备注册,订单历史,以及账户关闭流量.
- 命令和履行:管理控制台的Storefront订单,提前订单活动,指派/不指定驱动程序,标记准备状态,完成接货,并检查与路线和跟踪数据相配套的商业细节.
- 审查和表决:曝光API资源供客户审查和投票.
- 晋升和通知:管理通知频道,并通过APN、FCM以及相关的Storefront通知类发送广播或交易推动通知.
- 盘形板分析: 船舶 Storefront 部件,用于收入,订单量,平均订单值,活订单,完成订单,客户,推车转换,取消率,收入趋势,顶级产品,客户见解,订单状态组合,近期订单,以及近期客户.
- 舰队-Ops集成:在Fleet-Ops订单细节内注册 Storefront摘要,并给Fleet-Ops订单创建添加产品-实体工具.
- 国际化:通过扩展翻译文件包含多个地语的翻译.
客户应用
|
这个 存储前端 App 是此扩展的开源客户端应用程序,用于iOS,Android,以及网络. 客户浏览、订购、支付和跟踪其中的交货情况,通过 公共存储前端 API。 。 。 . 发射最简单的方法是 舰队基地 AppHelm,它把一个Fleetbase商店 出版 作为自己的品牌应用程序, 没有代码可写。 连接你的商店,设置你的品牌, 并预览应用程序与你真正的产品。 在网络上免费发布
|
建筑
此寄存器包含 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
安装依赖关系
pnpm install
composer install
后端软件包
composer require fleetbase/core-api
composer require fleetbase/fleetops-api
composer require fleetbase/storefront-api
前端软件包
pnpm install @fleetbase/storefront-engine
发展
关于当地舰队基地的全部工作流程,见 舰队基地开发设置指南。该指南涵盖以子模块克隆主寄存器,安装活包源,连接扩展,运行 Console dev 服务器,并在后端更改后重新加载API.
在舰队基地使用本地存储前端源
在Fleetbase monorepo内部开发 Storefront时, 从寄存器根运行包链接器, 所以本地 packages/storefront 源代码取代 Console 和 API 使用的已出版的 Storefront 包 :
flb-package-linker enable storefront
flb-package-linker install storefront
链接器更新了本地Console和API的开发表. 要检查当前链接状态 :
flb-package-linker status
flb-package-linker doctor
如果链接器尚未安装, 请从 Fleetbase 仓库根安装一次 :
npm link
连接后端包更改后, 重新装入运行中的 API 工人, 所以 Laravel Octane 将 PHP 更改 :
docker compose exec application php artisan octane:reload
对于前端修改,运行开发设置指南所描述的Fleetbase Console Dev服务器;链接到的Ember软件包由dev服务器监视并活重装.
软件包命令
本地运行 Ember 引擎 :
pnpm start
构建 Ember 引擎 :
pnpm build
运行前端插图和测试 :
pnpm lint
pnpm test
pnpm test:ember
运行后端检查 :
composer test:lint
composer test:types
composer test:unit
composer test
用 Xdebug 或 PCOV 生成并概括完整的后端 Clover 基线 :
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 审查访问 在他们的环境. |
STOREFRONT_REVIEW_ACCOUNTS | 以逗号分隔的电话号码和签名的电子邮件 STOREFRONT_BYPASS_VERIFICATION_CODE 并且从未发送过密码. |
STOREFRONT_THROTTLE_REQUESTS_PER_MINUTE | 每个窗口允许的公共 Storefront API 请求(存储密钥+客户端IP). 默认 120。 。 。 . |
STOREFRONT_THROTTLE_DECAY_MINUTES | 公共 Storefront API 节流阀窗口在几分钟内。 默认 1。 。 。 . |
关于客户应用程序配置,请参见 存储前端 App 配置文件。 。 。 .
文档
捐款
Storefront遵循与Fleet基地其余部分相同的审查预期:
- 保持更改小而可审查.
- 保存现有建筑和命名公约.
- 实用时添加或更新测试.
- 在打开拉动请求前运行相关的前端或后端验证命令.
- 对于API行为变化,检查API规格和公共文档是否需要更新.
见 捐款额 一般性捐款指导.
许可证
Fleetbase Storefront是开源软件,根据该软件许可 AGPL-3.0- 或- 后期。 。 。 .