ABC 用户反馈

ABC 用户反馈是一个独立的网络应用程序，用于管理客户之声（VoC）数据。它允许您收集和整理客户的反馈。该产品已应用于月活跃用户达1000万的服务中。

功能

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

入门指南

前端使用NextJS构建，后端使用NestJS构建。我们提供Docker镜像以便快速简便地进行设置。

系统要求

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

必需

• 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管理前端

docker pull line/abc-user-feedback-web

API后端

docker pull line/abc-user-feedback-api

配置

前端

:point_right: 前往前端README

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

后端

:point_right: 前往后端README

您可以配置后端的MySQL、用于电子邮件验证的SMTP、由OpenSearch支持的改进搜索体验等。

设置开发环境（本地）

ABC 用户反馈使用单一代码库（由TurboRepo提供支持），包含多个应用和包。

按照以下说明设置本地开发环境。

1. 克隆仓库并安装依赖：

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

2. 使用Docker Compose启动所有必需的基础设施（MySQL、OpenSearch等）：

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

3. 参考.env.example在apps/api和apps/web中创建.env文件（web环境变量，api环境变量）

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镜像。请参考使用turborepo的远程缓存和使用docker部署。

docker-compose build

然后，运行docker-compose

docker-compose up -d

贡献指南

请遵循贡献指南为项目做出贡献。

许可证

Copyright 2023 LINE Corporation

LINE 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.

详情请参阅LICENSE。