abc user feedback

Feedback do usuário da ABC

O feedback do usuário da ABC é um aplicativo Web independente que gerencia dados de voz dos clientes (VOC). Permite reunir e classificar feedback de seus clientes. O produto está sendo aplicado e usado em serviços no valor de 10 milhões de MAU.

Índice

• Características
• Começando
• Configuração
• Integração
• Desenvolvimento
• Contribuindo
• Licença

Características

O feedback do usuário da ABC fornece os seguintes recursos:

Começando

O front -end é construído com o NextJS e o back -end é construído com Nestjs. Fornecemos imagens do Docker para configuração rápida e fácil.

Requisitos do sistema

Antes de começar, verifique se você tem o seguinte instalado:

Obrigatório

• Node.js v20 ou acima
• Docker
• Mysql v8

Opcional

• SMTP - Para verificação de correio durante a fabricação de contas
• Opensearch V7 - Para desempenho na pesquisa de feedback

Você pode usar o arquivo Docker-comppose.infra-amd64.yml para obter requisitos.

Para arquitetura do ARM, use o arquivo docker-compose.infra-arm64.yml

Imagens do Docker Hub

Publicamos duas imagens em https://hub.docker.com a cada lançamento.

Frontend do administrador da web

docker pull line/abc-user-feedback-web

Back -end da API

docker pull line/abc-user-feedback-api

Configuração

Front-end

Vá para o Readme do Frontend

Você pode configurar o front -end para senha de sessão, tempo máximo de tempo para consultar, etc.

Back -end

Vá para o back -end ReadMe

Você pode configurar o back-end para o MySQL, SMTP para verificação de email, experiência de pesquisa melhorada em OpenEarch, etc.

Integração

Se você deseja integrar o feedback do usuário da ABC ao seu serviço, pode usar os seguintes recursos:

1. API da Web RESTful - página de documentos da API.
2. Aceite imagens da integração do usuário - S3.
3. Webhooks - Especificação Webhook.

Desenvolvimento

Configurar o ambiente de desenvolvimento usando a ferramenta de linha de comando sem dependências

O ABC User Feedback suporta uma ferramenta de linha de comando ( auf-cli ) que executa facilmente o front-end e o back-end.

Com esta ferramenta de linha de comando, você pode inicializar a infraestrutura e executar o aplicativo alimentado por uma imagem pré-configurada do docker. Como o CLI é executável com npx , apenas um ambiente npm é necessário e nenhuma outra dependência é necessária.

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

Consulte o seguinte site do pacote NPM: https://www.npmjs.com/package/auf-cli

Configurar o ambiente de dev manualmente (local)

O feedback do usuário da ABC está usando um Monorepo (alimentado pelo Turborepo) com vários aplicativos e pacotes.

Siga as instruções abaixo para configurar um ambiente de desenvolvimento local.

1. Clone o repositório e instale dependências:

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

2. Gire toda a infraestrutura necessária (MySQL, OpenSearch, etc.) usando o Docker Compose:

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

3. Faça um arquivo .env em apps/api e apps/web referindo -se a .env.example (variáveis de ambiente da web, variáveis de ambiente da API)

4. Aplicar migrações de banco de dados:

 cd apps/api
npm run migration:run

5. Para começar a desenvolver, execute o alvo dev de ambos os aplicativos no diretório raiz:

pnpm dev

6. Além disso, você pode executar o alvo dev de um dos aplicativos no diretório raiz:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

Construa a imagem do Docker

Para sua compilação de código, você pode criar a imagem do Docker usando o Docker-Compompose. Consulte o cache remoto e a implantação com o Docker usando turborepo .

 docker-compose build

Em seguida, execute o Docker-Compose

 docker-compose up -d

Diretrizes contribuintes

Siga as diretrizes contribuintes para contribuir para o projeto.

Licença

 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.

Consulte a licença para obter mais detalhes.