dailykit/hern

HERN (Hasura, Express, React, Node) 技术文档

1. 镜像概述和主要用途

HERN 是基于 Hasura、Express、React 和 Node.js 的集成开发环境，旨在提供订阅服务管理系统的完整技术栈。该项目整合了后端 API 服务、管理门户、消费者平台及模板服务，适用于构建订阅制产品的全流程管理应用，支持从后台数据管理到前端用户交互的全链路开发。

2. 核心功能和特性

2.1 Express Server

• 提供 REST API 接口，支持事件触发、库存管理、客户管理、事件记录等核心业务逻辑处理。

2.2 Admin

• 基于 React 构建的管理门户，用于管理订阅商店的产品、订阅计划、客户信息、订单数据等后台运营功能。

2.3 Store

• 基于 Next.js 构建的消费者平台，支持用户订阅计划选择、周订单提交等前端交互功能，面向终端用户提供服务。

2.4 Template Service

• 管理邮件、小包装（sachet）、标签、收据等业务模板的构建与生成，支持 HTML 或 PDF 格式输出。

3. 使用场景和适用范围

HERN 适用于需要快速开发订阅服务管理系统的技术团队，尤其适合以下场景：

• 构建订阅制产品的后端 API 与前端管理界面
• 开发消费者订阅平台（如周期性配送服务、会员订阅等）
• 集成事件触发、库存跟踪、订单管理等业务逻辑
• 统一管理业务相关模板（通知邮件、订单收据等）

4. 使用方法和配置说明

4.1 环境准备

4.1.1 克隆代码仓库

bash
git clone https://github.com/dailykit/HERN.git

4.1.2 切换至开发分支

bash
git checkout staging

4.1.3 配置环境变量

创建 .env 文件，并根据项目根目录下的 .env.example 文件填充所需环境变量参数。

4.1.4 安装依赖包

bash
yarn install:packages

4.2 启动 Express 服务器

后端服务默认运行在端口 4000：

bash
yarn dev:server

4.3 生成 Admin 和 Store 环境配置文件

通过 POST 请求触发配置文件生成：

bash
curl -X POST 'http://localhost:4000/server/api/envs'

4.4 运行 Admin 管理门户

切换至 Admin 目录并启动应用，默认运行在端口 8000：

bash
cd admin && yarn start

4.5 运行 Store 消费者平台

切换至 Store 目录并启动应用，默认运行在端口 3000：

bash
cd store && yarn dev

5. 注意事项

• 各组件默认端口：Express Server (4000)、Admin (8000)、Store (3000)，需确保端口未被占用
• 环境变量配置需完整，缺失关键参数可能导致服务启动失败
• Admin 和 Store 应用依赖 Express 服务器生成的环境配置文件，需先完成 4.3 步骤