abc user feedback

Commentaires des utilisateurs ABC

Les commentaires des utilisateurs ABC sont une application Web autonome qui gère les données de la voix des clients (COV). Il vous permet de rassembler et de trier les commentaires de vos clients. Le produit est appliqué et utilisé dans les services d'une valeur de 10 millions de MAU.

Table des matières

• Caractéristiques
• Commencer
• Configuration
• Intégration
• Développement
• Contributif
• Licence

Caractéristiques

Les commentaires des utilisateurs ABC fournissent les fonctionnalités suivantes:

Commencer

Le frontend est construit avec NextJS et le backend est construit avec NESTJS. Nous fournissons des images Docker pour une configuration rapide et facile.

Exigences du système

Avant de commencer, assurez-vous que vous avez installé les suivants:

Requis

• Node.js v20 ou supérieur
• Docker
• Mysql v8

Facultatif

• SMTP - Pour la vérification du courrier lors de la fabrication de comptes
• Opensearch V7 - pour les performances sur la recherche de commentaires

Vous pouvez utiliser le fichier docker-compose.infra-amd64.yml pour les exigences.

Pour l'architecture du bras, utilisez le fichier docker-compose.infra-arm64.yml

Images Docker Hub

Nous publions deux images sur https://hub.docker.com à chaque version.

Frontend administratif Web

docker pull line/abc-user-feedback-web

Backend API

docker pull line/abc-user-feedback-api

Configuration

L'extrémité avant

Aller à Frontend Readme

Vous pouvez configurer le frontend pour le mot de passe de session, une durée maximale pour interroger, etc.

Backend

Allez à Backend Readme

Vous pouvez configurer le backend pour MySQL, SMTP pour la vérification par e-mail, une expérience de recherche améliorée à OpenSearch, etc.

Intégration

Si vous souhaitez intégrer les commentaires des utilisateurs ABC avec votre service, vous pouvez utiliser les fonctionnalités suivantes:

1. API Web RESTFul - Page de document API.
2. Acceptez les images de l'intégration de l'utilisateur - S3.
3. WebHooks - Spécification Webhook.

Développement

Configuration de l'environnement de développement à l'aide de l'outil de ligne de commande sans dépendances

ABC Utilising Feedback prend en charge un outil de ligne de commande ( auf-cli ) qui exécute facilement le frontend et le backend.

Avec cet outil de ligne de commande, vous pouvez initialiser l'infrastructure et exécuter l'application alimentée par une image Docker pré-configurée. Étant donné que la CLI est exécutable avec npx , seul un environnement npm est requis et aucune autre dépendance n'est nécessaire.

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

Veuillez vous référer au site du package NPM suivant: https://www.npmjs.com/package/auf-cli

Configurer un environnement Dev manuellement (local)

ABC User Feedback utilise un monorepo (alimenté par TurborePo) avec plusieurs applications et packages.

Suivez les instructions ci-dessous pour configurer un environnement de développement local.

1. Clone le référentiel et les dépendances d'installation:

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

2. Tournez toutes les infrastructures requises (MySQL, OpenSesearch, etc.) à l'aide de Docker Compose:

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

3. Créez un fichier .env dans apps/api et apps/web en faisant référence à .env.example (variables d'environnement Web, variables d'environnement API)

4. Appliquer les migrations de la base de données:

 cd apps/api
npm run migration:run

5. Pour commencer à se développer, exécutez la cible du dev des deux applications dans Root Directory:

pnpm dev

6. En outre, vous pouvez exécuter l'objectif dev de l'une des applications dans Root Directory:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

Construire l'image Docker

Pour votre version de code, vous pouvez créer une image Docker à l'aide de Docker-Compose. Veuillez vous référer à la mise en cache distante et au déploiement avec Docker à l'aide de turborepo .

 docker-compose build

Ensuite, exécutez Docker-Compose

 docker-compose up -d

Lignes directrices contributives

Veuillez suivre les directives contributives pour contribuer au projet.

Licence

 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.

Voir la licence pour plus de détails.