abc user feedback

ABC 사용자 피드백

ABC 사용자 피드백은 VOC (Voice of Customer) 데이터를 관리하는 독립형 웹 응용 프로그램입니다. 고객으로부터 피드백을 수집하고 정렬 할 수 있습니다. 이 제품은 1 천만 MAU의 서비스에 적용되고 사용됩니다.

목차

• 특징
• 시작하기
• 구성
• 완성
• 개발
• 기여
• 특허

특징

ABC 사용자 피드백은 다음과 같은 기능을 제공합니다.

시작하기

프론트 엔드는 NextJS로 제작되었으며 백엔드는 NestJS로 구축됩니다. 빠르고 쉬운 설정을 위해 Docker 이미지를 제공합니다.

시스템 요구 사항

시작하기 전에 다음과 같은 설치가 있는지 확인하십시오.

필수의

• node.js v20 이상
• 도커
• MySQL V8

선택 과목

• SMTP- 계정 제작 중 우편 확인 용
• OpenSearch V7- 피드백 검색 성능

요구 사항에는 docker-compose.infra-amd64.yml 파일을 사용할 수 있습니다.

ARM 아키텍처의 경우 docker-compose.infra-arm64.yml 파일을 사용하십시오

도커 허브 이미지

우리는 릴리스마다 https://hub.docker.com에 두 개의 이미지를 게시합니다.

웹 관리자 프론트 엔드

docker pull line/abc-user-feedback-web

API 백엔드

docker pull line/abc-user-feedback-api

구성

프론트 엔드

Frontend Readme로 이동하십시오

세션 비밀번호, 최대 시간 범위의 쿼리 등의 프론트 엔드를 구성 할 수 있습니다.

백엔드

ReadMe를 백엔드로 이동하십시오

MySQL의 백엔드, 이메일 확인에 대한 SMTP, OpenSearch 구동 향상 검색 경험 등을 구성 할 수 있습니다.

완성

ABC 사용자 피드백을 서비스와 통합하려면 다음 기능을 사용할 수 있습니다.

1. RESTFUL WEB API -API 문서 페이지.
2. 사용자 -S3 통합에서 이미지를 허용합니다.
3. WebHooks- 웹 후크 사양.

개발

종속성없이 명령 줄 도구를 사용하여 DEV 환경을 설정합니다

ABC 사용자 피드백은 프론트 엔드와 백엔드를 쉽게 실행하는 auf-cli (Command Line Tool)를 지원합니다.

이 명령 줄 도구를 사용하면 인프라를 초기화하고 사전 구성된 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. Docker Compose를 사용하여 필요한 모든 필요한 인프라 (MySQL, OpenSearch 등)를 분사합니다.

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

3. .env.example (웹 환경 변수, API 환경 변수)을 참조하여 apps/api 및 apps/web 에서 .env 파일을 만듭니다.

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-Compose를 사용하여 Docker 이미지를 빌드 할 수 있습니다. turborepo 사용하여 원격 캐싱 및 Docker와 함께 배포하십시오.

 docker-compose build

그런 다음 Docker-Compose를 실행하십시오

 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.

자세한 내용은 라이센스를 참조하십시오.