abc user feedback

คำติชมของผู้ใช้ ABC

ความคิดเห็นของผู้ใช้ ABC เป็นแอปพลิเคชันเว็บแบบสแตนด์อโลนที่จัดการข้อมูลเสียงของลูกค้า (VOC) ช่วยให้คุณรวบรวมและจัดเรียงข้อเสนอแนะจากลูกค้าของคุณ ผลิตภัณฑ์กำลังถูกนำไปใช้และใช้ในบริการมูลค่า 10 ล้าน MAU

สารบัญ

• คุณสมบัติ
• เริ่มต้น
• การกำหนดค่า
• การรวมเข้าด้วยกัน
• การพัฒนา
• การบริจาค
• ใบอนุญาต

คุณสมบัติ

คำติชมของผู้ใช้ ABC มีคุณสมบัติต่อไปนี้:

เริ่มต้น

ส่วนหน้าถูกสร้างขึ้นด้วย nextjs และแบ็กเอนด์ถูกสร้างขึ้นด้วย Nestjs เราให้ภาพนักเทียบท่าสำหรับการตั้งค่าที่ง่ายและง่ายดาย

ข้อกำหนดของระบบ

ก่อนที่คุณจะเริ่มตรวจสอบให้แน่ใจว่าคุณติดตั้งดังต่อไปนี้:

ที่จำเป็น

• node.js v20 ขึ้นไป
• นักเทียบท่า
• mysql v8

ไม่จำเป็น

• SMTP - สำหรับการตรวจสอบจดหมายระหว่างการทำบัญชี
• OpenSearch V7 - สำหรับประสิทธิภาพในการค้นหาข้อเสนอแนะ

คุณสามารถใช้ไฟล์ Docker-compose.infra-amd64.yml สำหรับข้อกำหนด

สำหรับสถาปัตยกรรมแขนให้ใช้ไฟล์ Docker-compose.infra-arm64.yml

ภาพฮับ Docker

เราเผยแพร่สองภาพไปที่ https://hub.docker.com ทุกรุ่น

ฝ่ายดูแลเว็บส่วนหน้า

docker pull line/abc-user-feedback-web

แบ็กเอนด์ API

docker pull line/abc-user-feedback-api

การกำหนดค่า

ส่วนหน้า

ไปที่ Frontend Readme

คุณสามารถกำหนดค่าส่วนหน้าสำหรับรหัสผ่านเซสชันช่วงเวลาสูงสุดในการสืบค้น ฯลฯ

แบ็กเอนด์

ไปที่ Backend Readme

คุณสามารถกำหนดค่าแบ็กเอนด์สำหรับ MySQL, SMTP สำหรับการตรวจสอบอีเมล, ประสบการณ์การค้นหาที่ได้รับการปรับปรุงโดยเปิดใช้งาน ฯลฯ

การรวมเข้าด้วยกัน

หากคุณต้องการรวมความคิดเห็นของผู้ใช้ ABC เข้ากับบริการของคุณคุณสามารถใช้คุณสมบัติต่อไปนี้:

1. หน้าเว็บ Restful API - หน้าเอกสาร API
2. ยอมรับรูปภาพจากการรวมผู้ใช้ - S3
3. WebHooks - ข้อกำหนด WebHook

การพัฒนา

การตั้งค่าสภาพแวดล้อม dev โดยใช้เครื่องมือบรรทัดคำสั่งโดยไม่ต้องพึ่งพา

ความคิดเห็นของผู้ใช้ ABC รองรับเครื่องมือบรรทัดคำสั่ง ( auf-cli ) ที่ทำงานได้อย่างง่ายดายทั้งส่วนหน้าและแบ็กเอนด์

ด้วยเครื่องมือบรรทัดคำสั่งนี้คุณสามารถเริ่มต้นโครงสร้างพื้นฐานและเรียกใช้แอพที่ขับเคลื่อนด้วยภาพนักเทียบท่าที่กำหนดค่าล่วงหน้า เนื่องจาก 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-li

การตั้งค่า dev environment ด้วยตนเอง (ท้องถิ่น)

คำติชมของผู้ใช้ 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 ของหนึ่งในแอพใน Root Directory:

 # web
pnpm turbo run dev --filter=web

# api
pnpm turbo run dev --filter=api

สร้างภาพนักเทียบท่า

สำหรับการสร้างรหัสของคุณคุณสามารถสร้างอิมเมจ Docker โดยใช้ Docker-compose โปรดดูการแคชระยะไกลและการปรับใช้กับ Docker โดยใช้ turborepo

 docker-compose build

จากนั้นเรียกใช้ compose docker

 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.

ดูใบอนุญาตสำหรับรายละเอียดเพิ่มเติม