abc user feedback

Umpan Balik Pengguna ABC

Umpan Balik Pengguna ABC adalah aplikasi web mandiri yang mengelola data suara pelanggan (VOC). Ini memungkinkan Anda untuk mengumpulkan dan mengurutkan umpan balik dari pelanggan Anda. Produk ini diterapkan dan digunakan dalam layanan senilai 10 juta MAU.

Daftar isi

• Fitur
• Memulai
• Konfigurasi
• Integrasi
• Perkembangan
• Berkontribusi
• Lisensi

Fitur

Umpan Balik Pengguna ABC menyediakan fitur -fitur berikut:

Memulai

Frontend dibangun dengan NextJS dan backend dibangun dengan NestJs. Kami menyediakan gambar Docker untuk pengaturan yang cepat dan mudah.

Persyaratan sistem

Sebelum Anda mulai, pastikan Anda menginstal berikut:

Diperlukan

• Node.js v20 atau lebih
• Buruh pelabuhan
• Mysql v8

Opsional

• SMTP - Untuk verifikasi surat selama membuat akun
• OpenSearch v7 - untuk kinerja pencarian umpan balik

Anda dapat menggunakan file Docker-compose.infra-Amd64.yml untuk persyaratan.

Untuk arsitektur ARM, gunakan file Docker-compose.infra-manch64.yml

Gambar hub Docker

Kami menerbitkan dua gambar ke https://hub.docker.com di setiap rilis.

Frontend Admin Web

docker pull line/abc-user-feedback-web

API Backend

docker pull line/abc-user-feedback-api

Konfigurasi

Frontend

Pergi ke Frontend Readme

Anda dapat mengonfigurasi frontend untuk kata sandi sesi, rentang waktu maksimum untuk permintaan, dll.

Backend

Pergi ke backend readme

Anda dapat mengonfigurasi backend untuk MySQL, SMTP untuk verifikasi email, pengalaman pencarian yang ditingkatkan dengan peningkatan OpenSearch, dll.

Integrasi

Jika Anda ingin mengintegrasikan umpan balik pengguna ABC dengan layanan Anda, Anda dapat menggunakan fitur berikut:

1. Halaman dokumen API Web Restful - API.
2. Terima gambar dari integrasi pengguna - S3.
3. Webhooks - Spesifikasi WebHook.

Perkembangan

Pengaturan Lingkungan Dev Menggunakan Alat Baris Perintah Tanpa Ketergantungan

Umpan Balik Pengguna ABC mendukung alat baris perintah ( auf-cli ) yang dengan mudah menjalankan frontend dan backend.

Dengan alat baris perintah ini, Anda dapat menginisialisasi infrastruktur dan menjalankan aplikasi yang ditenagai oleh gambar Docker yang telah dikonfigurasi sebelumnya. Karena CLI dapat dieksekusi dengan npx , hanya diperlukan lingkungan npm , dan tidak ada dependensi lain yang diperlukan.

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

Silakan merujuk ke Situs Paket NPM berikut: https://www.npmjs.com/package/aufli

Pengaturan Lingkungan Dev secara manual (lokal)

Umpan balik pengguna ABC menggunakan monorepo (ditenagai oleh turborepo) dengan banyak aplikasi dan paket.

Ikuti instruksi di bawah ini untuk mengatur lingkungan pengembangan lokal.

1. Kloning repositori dan instal dependensi:

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

2. Berputar semua infrastruktur yang diperlukan (MySQL, OpenSearch, dll.) Menggunakan Docker Compose:

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

3. Buat file .env di apps/api dan apps/web dengan merujuk pada .env.example (variabel lingkungan web, variabel lingkungan API)

4. Terapkan Migrasi Basis Data:

 cd apps/api
npm run migration:run

5. Untuk mulai berkembang, jalankan target dev dari kedua aplikasi di direktori root:

pnpm dev

6. Anda juga dapat menjalankan target dev dari salah satu aplikasi di direktori root:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

Bangun gambar Docker

Untuk pembuatan kode Anda, Anda dapat membangun gambar Docker menggunakan Docker-Compose. Silakan merujuk ke caching jarak jauh dan digunakan dengan Docker menggunakan turborepo .

 docker-compose build

Kemudian, jalankan komposisi Docker

 docker-compose up -d

Pedoman yang berkontribusi

Harap ikuti pedoman yang berkontribusi untuk berkontribusi pada proyek.

Lisensi

 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.

Lihat lisensi untuk detail lebih lanjut.