abc user feedback

ABCユーザーフィードバック

ABCユーザーフィードバックは、顧客のVoice（VOC）データを管理するスタンドアロンWebアプリケーションです。これにより、顧客からフィードバックを収集してソートすることができます。製品は適用され、1,000万Mau相当のサービスで使用されています。

目次

• 特徴
• はじめる
• 構成
• 統合
• 発達
• 貢献
• ライセンス

特徴

ABCユーザーフィードバックは、次の機能を提供します。

はじめる

フロントエンドはNextJSで構築され、バックエンドはNESTJで構築されています。高速で簡単なセットアップのためにDocker画像を提供します。

システム要件

開始する前に、次のインストールがあることを確認してください。

必須

• node.js v20以降
• Docker
• mysql v8

オプション

• SMTP-アカウントの作成中のメール検証用
• OpenSearch V7-フィードバックの検索のパフォーマンス

要件には、docker-compose.infra-amd64.ymlファイルを使用できます。

アームアーキテクチャには、docker-compose.infra-arm64.ymlファイルを使用します

Dockerハブ画像

すべてのリリースで2つの画像をhttps://hub.docker.comに公開します。

Web管理フロントエンド

docker pull line/abc-user-feedback-web

APIバックエンド

docker pull line/abc-user-feedback-api

構成

フロントエンド

FrontEnd Readmeに移動します

セッションパスワードのフロントエンド、最大時間スパンからクエリなどを構成できます。

バックエンド

BackEnd Readmeに移動します

メール検証用の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ユーザーフィードバックは、複数のアプリとパッケージを備えたモノレポ（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 （Web環境変数、API環境変数）を参照してapps/apiおよびapps/webで.envファイルを作成します。

4. データベースの移行を適用します：

 cd apps/api
npm run migration:run

5. 開発を開始するには、ルートディレクトリで両方のアプリのdevターゲットを実行します。

pnpm dev

6. また、ルートディレクトリでアプリの1つの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 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.

詳細については、ライセンスを参照してください。