abc user feedback

ملاحظات المستخدم ABC

ملاحظات المستخدم ABC هي تطبيق ويب مستقل يدير بيانات صوت العميل (VOC). يتيح لك جمع وفرز التعليقات من عملائك. يتم تطبيق المنتج ويستخدم في الخدمات بقيمة 10 ملايين ماو.

جدول المحتويات

• سمات
• ابدء
• إعدادات
• اندماج
• تطوير
• المساهمة
• رخصة

سمات

توفر ملاحظات مستخدم ABC الميزات التالية:

ابدء

تم بناء الواجهة الأمامية مع NextJs وتم بناء الواجهة الخلفية مع NestJS. نحن نقدم صور Docker لإعداد سريع وسهل.

متطلبات النظام

قبل أن تبدأ ، تأكد من تثبيت ما يلي:

مطلوب

• node.js v20 أو أعلى
• عامل ميناء
• MySQL V8

خياري

• SMTP - للتحقق من البريد أثناء صنع الحسابات
• OpenSearch V7 - للأداء عند البحث عن ردود الفعل

يمكنك استخدام ملف docker-corm.infra-amd64.yml للمتطلبات.

لعمارة الذراع ، استخدم ملف Docker-corm.infra-arm64.yml

صور Docker Hub

ننشر صورتين إلى https://hub.docker.com في كل إصدار.

ويب مسؤول الواجهة

docker pull line/abc-user-feedback-web

API الخلفية

docker pull line/abc-user-feedback-api

إعدادات

الواجهة

اذهب إلى المقدمة readme

يمكنك تكوين الواجهة الأمامية لكلمة مرور الجلسة ، وأقصى فترة زمنية للاستعلام ، إلخ.

الخلفية

اذهب إلى الخلفية ReadMe

يمكنك تكوين الواجهة الخلفية لـ MySQL و SMTP للتحقق من البريد الإلكتروني وتجربة البحث المحسّنة التي تعمل بنظام OpenSearch ، إلخ.

اندماج

إذا كنت ترغب في دمج ملاحظات مستخدمي ABC مع خدمتك ، يمكنك استخدام الميزات التالية:

1. RESTFLE WEB API - صفحة مستند API.
2. قبول الصور من User - S3 تكامل.
3. Webhooks - مواصفات webhook.

تطوير

إعداد بيئة DEV باستخدام أداة سطر الأوامر بدون تبعيات

تدعم ملاحظات مستخدم 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

إعداد بيئة DEV يدويًا (محلي)

تستخدم ملاحظات المستخدم ABC monorepo (مدعوم من Turborepo) مع تطبيقات وحزم متعددة.

اتبع التعليمات أدناه لإعداد بيئة تنمية محلية.

1. استنساخ المستودع وتثبيت التبعيات:

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

2. قم بتدوير جميع البنية التحتية المطلوبة (MySQL ، OpenSearch ، إلخ) باستخدام Docker Compose:

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

3. قم بعمل ملف .env في apps/api و apps/web من خلال الإشارة إلى .env.example (متغيرات بيئة الويب ، متغيرات بيئة API)

4. تطبيق ترحيل قاعدة البيانات:

 cd apps/api
npm run migration:run

5. لبدء التطوير ، قم بتشغيل هدف dev لكل من التطبيقات في دليل الجذر:

pnpm dev

6. أيضًا ، يمكنك تشغيل هدف dev لأحد التطبيقات في دليل الجذر:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

بناء صورة Docker

لبناء الكود الخاص بك ، يمكنك إنشاء صورة Docker باستخدام Docker-Cormse. يرجى الرجوع إلى التخزين المؤقت عن بُعد والنشر مع Docker باستخدام turborepo .

 docker-compose build

ثم ، قم بتشغيل Docker-Corm

 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.

انظر الترخيص لمزيد من التفاصيل.