abc user feedback

ABC -Benutzer -Feedback

ABC User Feedback ist eine eigenständige Webanwendung, die Voice of Customer -Daten (VOC) verwaltet. Dadurch können Sie Feedback Ihrer Kunden sammeln und sortieren. Das Produkt wird in Dienstleistungen im Wert von 10 Millionen Mau angewendet und verwendet.

Inhaltsverzeichnis

• Merkmale
• Erste Schritte
• Konfiguration
• Integration
• Entwicklung
• Beitragen
• Lizenz

Merkmale

ABC User Feedback bietet die folgenden Funktionen:

Erste Schritte

Das Frontend ist mit NextJs gebaut und das Backend ist mit NestJs gebaut. Wir bieten Docker -Bilder für schnelles und einfaches Setup.

Systemanforderungen

Stellen Sie vor Beginn sicher, dass Sie Folgendes installiert haben:

Erforderlich

• Node.js v20 oder höher
• Docker
• Mysql V8

Optional

• SMTP - Für die E -Mail -Überprüfung während der Erstellung von Konten
• OpenSearch V7 - Für die Leistung beim Suchen von Feedback

Sie können docer-compose.infra-amd64.yml-Datei für Anforderungen verwenden.

Verwenden Sie für die ARM-Architektur Docker-compose.infra-arme64.yml-Datei

Docker Hub Bilder

Wir veröffentlichen bei jeder Version zwei Bilder auf https://hub.docker.com.

Web Admin -Frontend

docker pull line/abc-user-feedback-web

API -Backend

docker pull line/abc-user-feedback-api

Konfiguration

Frontend

Gehen Sie zum Frontend Readme

Sie können das Frontend für das Sitzungskennwort, die maximale Zeitspanne für Abfragen usw. konfigurieren.

Backend

Geh zum Backend Readme

Sie können das Backend für MySQL, SMTP für E-Mail-Überprüfung, openSearch-betriebene Sucherfahrung usw. konfigurieren.

Integration

Wenn Sie ABC -Benutzer -Feedback in Ihren Dienst integrieren möchten, können Sie die folgenden Funktionen verwenden:

1. RESTful Web API - API -Dokumentseite.
2. Akzeptieren Sie Bilder von Benutzer - S3 -Integration.
3. Webhooks - Webhook -Spezifikation.

Entwicklung

Setup Dev -Umgebung mit dem Befehlszeilen -Tool ohne Abhängigkeiten einrichten

ABC User Feedback unterstützt ein Befehlszeilen-Tool ( auf-cli ), das sowohl das Frontend als auch das Backend ausführt.

Mit diesem Befehlszeilen-Tool können Sie die Infrastruktur initialisieren und die App ausführen, die von einem vorkonfigurierten Docker-Bild betrieben wird. Da die CLI mit npx ausführbar ist, ist nur eine npm -Umgebung erforderlich, und es sind keine anderen Abhängigkeiten erforderlich.

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

Weitere Informationen finden Sie auf der folgenden NPM-Paket-Site: https://www.npmjs.com/package/auf-cli

Setup Dev Umgebung manuell (lokal)

ABC User Feedback verwendet ein Monorepo (von Turborepo betrieben) mit mehreren Apps und Paketen.

Befolgen Sie die folgenden Anweisungen, um eine lokale Entwicklungsumgebung einzurichten.

1. Klonen Sie das Repository und installieren Sie Abhängigkeiten:

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

2. Drehen Sie alle erforderlichen Infrastrukturen (MySQL, OpenSearch usw.) mit Docker Compose:

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

3. Erstellen Sie eine .env -Datei in apps/api und apps/web , indem Sie sich auf .env.example (Webumgebungsvariablen, API -Umgebungsvariablen) beziehen.

4. Datenbankmigrationen anwenden:

 cd apps/api
npm run migration:run

5. Führen Sie das dev beider Apps im Root -Verzeichnis aus:

pnpm dev

6. Außerdem können Sie das dev einer von Apps im Root -Verzeichnis ausführen:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

Bauen Sie das Docker -Bild

Für Ihren Codeaufbau können Sie Docker-Bild mit Docker-Compose erstellen. Weitere Informationen finden Sie im Remote -Caching und Bereitstellen mit Docker mit turborepo .

 docker-compose build

Dann führen Sie Docker-Compose aus

 docker-compose up -d

Richtlinien beitragen

Bitte befolgen Sie die beitragenden Richtlinien, um zum Projekt beizutragen.

Lizenz

 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.

Weitere Informationen finden Sie unter Lizenz.