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.

有關更多詳細信息，請參見許可證。