abc user feedback

ABC用户反馈

ABC用户反馈是一个独立的Web应用程序，可管理客户语音（VOC）数据。它使您可以收集和分类客户的反馈。该产品正在应用和用于价值1000万MAU的服务中。

目录

• 特征
• 入门
• 配置
• 一体化
• 发展
• 贡献
• 执照

特征

ABC用户反馈提供以下功能：

入门

前端是用NextJ构建的，后端是用Nestjs构建的。我们为快速简便的设置提供Docker图像。

系统要求

在开始之前，请确保已安装以下内容：

必需的

• node.js v20或更高
• Docker
• mysql v8

选修的

• SMTP-进行帐户期间的邮件验证
• OpenSearch v7-用于搜索反馈的性能

您可以使用Docker-compose.infra-amd64. yml文件以获取要求。

对于ARM架构，请使用Docker-Compose.infra-Arm64.yml文件

Docker Hub图像

我们在每个版本中将两个图像发布到https://hub.docker.com。

Web Admin前端

docker pull line/abc-user-feedback-web

API后端

docker pull line/abc-user-feedback-api

配置

前端

转到前端读数

您可以为会话密码配置前端，查询最大时间跨度等。

后端

转到后端读书我

您可以为MySQL，SMTP配置用于电子邮件验证的后端，开放搜索供电的改进搜索体验等。

一体化

如果要将ABC用户的反馈与您的服务集成在一起，则可以使用以下功能：

1. RESTFUL WEB API -API文档页面。
2. 接受来自用户-S3集成的图像。
3. Webhooks -Webhook规范。

发展

使用命令行工具设置开发环境无依赖项

ABC用户反馈支持命令行工具（ auf-cli ），该工具轻松地运行前端和后端。

使用此命令行工具，您可以初始化基础架构并运行由预配置Docker映像提供动力的应用程序。由于CLI可以使用npx执行，因此仅需要npm环境，并且不需要其他依赖项。

npx auf-cli init # initialize infrastructure
npx auf-cli start # start app
npx auf-cli stop # stop app

请参阅以下NPM软件包网站：https：//www.npmjs.com/package/auf-cli

手动设置开发环境（本地）

ABC用户反馈使用的是带有多个应用程序和软件包的MonorePo（由TurborePo提供动力）。

请按照以下说明建立本地开发环境。

1. 克隆存储库并安装依赖项：

git clone https://github.com/line/abc-user-feedback
cd abc-user-feedback
pnpm install

2. 使用Docker组成：旋转所有必需的基础架构（MySQL，OpenSearch等）：

docker-compose -f docker/docker-compose.infra-amd64.yml up -d

3. 通过参考.env.example （Web环境变量，API环境变量），在apps/api和apps/web中制作.env文件

4. 应用数据库迁移：

 cd apps/api
npm run migration:run

5. 要开始开发，请在根目录中运行两个应用程序的dev目标：

pnpm dev

6. 另外，您可以在根目录中运行一个应用程序的dev目标：

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

构建Docker图像

对于您的代码构建，您可以使用Docker-Compose构建Docker Image。请使用turborepo参考远程缓存和与Docker部署。

 docker-compose build

然后，运行Docker-Compose

 docker-compose up -d

贡献准则

请遵循为项目贡献的贡献指南。

执照

 Copyright 2024 LY Corporation

LY Corporation licenses this file to you under the Apache License,
version 2.0 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at:

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.

有关更多详细信息，请参见许可证。