abc user feedback

Comentarios de los usuarios de ABC

La retroalimentación de los usuarios de ABC es una aplicación web independiente que administra los datos de la voz de la voz (VOC). Le permite reunir y clasificar los comentarios de sus clientes. El producto se aplica y se usa en servicios por valor de 10 millones de mAU.

Tabla de contenido

• Características
• Empezando
• Configuración
• Integración
• Desarrollo
• Que contribuye
• Licencia

Características

La retroalimentación de los usuarios de ABC proporciona las siguientes características:

Empezando

El frontend está construido con NextJS y el backend está construido con Nestjs. Proporcionamos imágenes de Docker para una configuración rápida y fácil.

Requisitos del sistema

Antes de comenzar, asegúrese de tener lo siguiente instalado:

Requerido

• Node.js v20 o superior
• Estibador
• Mysql v8

Opcional

• SMTP - Para la verificación del correo durante la fabricación de cuentas
• OpenSearch V7 - para el rendimiento en la búsqueda de comentarios

Puede usar Docker-Compose.infra-amd64.yml File para requisitos.

Para la arquitectura ARM, use Docker-Compose.infra-Arm64.yml File

Imágenes de Docker Hub

Publicamos dos imágenes en https://hub.docker.com en cada versión.

Frontend del administrador web

docker pull line/abc-user-feedback-web

Backend de la API

docker pull line/abc-user-feedback-api

Configuración

Interfaz

Ir a frontend readme

Puede configurar el frontend para la contraseña de sesión, el tramo de tiempo máximo a la consulta, etc.

Backend

Ir a Readme Backend

Puede configurar el backend para MySQL, SMTP para la verificación por correo electrónico, experiencia de búsqueda mejorada con OpenSearch, etc.

Integración

Si desea integrar los comentarios de los usuarios de ABC con su servicio, puede usar las siguientes funciones:

1. API web RESTful - Página de documento API.
2. Acepte imágenes del usuario - Integración S3.
3. Webhooks - Especificación de webhook.

Desarrollo

Configurar el entorno de desarrollo utilizando la herramienta de línea de comandos sin dependencias

La retroalimentación del usuario de ABC admite una herramienta de línea de comandos ( auf-cli ) que ejecuta fácilmente el frontend y el backend.

Con esta herramienta de línea de comandos, puede inicializar la infraestructura y ejecutar la aplicación alimentada por una imagen de Docker preconfigurada. Dado que la CLI es ejecutable con npx , solo se requiere un entorno npm y no se necesitan otras dependencias.

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

Consulte el siguiente sitio del paquete NPM: https://www.npmjs.com/package/auf-cli

Configurar el entorno de desarrollo manualmente (local)

La retroalimentación de los usuarios de ABC está utilizando un Monorepo (alimentado por Turborepo) con múltiples aplicaciones y paquetes.

Siga las instrucciones a continuación para configurar un entorno de desarrollo local.

1. Clon el repositorio e instalación de dependencias:

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

2. Gire toda la infraestructura requerida (MySQL, OpenSearch, etc.) usando Docker Compose:

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

3. Haga un archivo .env en apps/api y apps/web refiriéndose a .env.example (variables de entorno web, variables de entorno API)

4. Aplicar migraciones de bases de datos:

 cd apps/api
npm run migration:run

5. Para comenzar a desarrollar, ejecute el objetivo dev de ambas aplicaciones en el directorio raíz:

pnpm dev

6. Además, puede ejecutar el objetivo dev de una de las aplicaciones en el directorio raíz:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

Imagen de Docker de construcción

Para su compilación de código, puede crear una imagen de Docker usando Docker-Compose. Consulte el almacenamiento en caché y la implementación remota con Docker usando turborepo .

 docker-compose build

Entonces, ejecute Docker-Compose

 docker-compose up -d

Pautas contribuyentes

Siga las pautas contribuyentes para contribuir al proyecto.

Licencia

 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.

Vea la licencia para más detalles.