https://github.com/line/abc-user-feedback
ABC User Feedback is a standalone web application that manages Voice of Customer (VoC) data. It allows you to gather and sort feedback from your customers.
https://github.com/line/abc-user-feedback
docker docker-compose feedback-form nestjs nextjs typeorm typescript voc
Last synced: 9 months ago
JSON representation
ABC User Feedback is a standalone web application that manages Voice of Customer (VoC) data. It allows you to gather and sort feedback from your customers.
- Host: GitHub
- URL: https://github.com/line/abc-user-feedback
- Owner: line
- License: apache-2.0
- Created: 2021-09-13T06:38:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:01:10.000Z (about 1 year ago)
- Last Synced: 2024-10-29T15:23:47.663Z (about 1 year ago)
- Topics: docker, docker-compose, feedback-form, nestjs, nextjs, typeorm, typescript, voc
- Language: TypeScript
- Homepage:
- Size: 56.8 MB
- Stars: 279
- Watchers: 8
- Forks: 26
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ABC User Feedback
ABC User Feedback is a standalone web application that manages Voice of Customer (VoC) data. It allows you to gather and sort feedback from your customers. The product is being applied and used in services worth 10 million MAU.
## Table of Contents
- [Features](#-features)
- [Getting Started](#Getting-Started)
- [Configuration](#configuration)
- [Integration](#Integration)
- [Development](#Development)
- [Contributing](#Contributing-Guidelines)
- [License](#license)
## ✨ Features
|  |  |
| ------------------------------------------- | ----------------------------------------- |
|  |  |
|  |  |
- **Feedback Tag**: You can assign tags to each feedback to categorize them by topic.
- **Kanban Mode**: Experience the advantage of organizing and visualizing issue groups efficiently with Kanban mode.
- **Issue Tracker**: The Issue feature has a status indicator that lets you use it as a simple issue tracker. You can also link each issue to a ticket in your own issue tracker system.
- **Single Sign-on**: Authentication offers OAuth to accommodate enterprise-level single sign-on (SSO) requirements.
- **Role Management**: Role Based Access Control (RBAC)
- **Dashboard**: Dashboard help you visualize statistical data about your feedback and issues so you can learn about them at a glance.
## Getting Started
The frontend is built with NextJS and the backend is built with NestJS. We provide Docker images for fast and easy setup.
### System Requirements
:bulb: Before you begin, make sure you have the following installed:
**Required**
- [Node.js v22 or above](https://nodejs.org/en/download/)
- [Docker](https://docs.docker.com/desktop/)
- [MySQL v8](https://www.mysql.com/downloads/)
**Optional**
- SMTP - for mail verification during making accounts
- [OpenSearch v2.16](https://opensearch.org/) - for performance on searching feedback
You can use [docker-compose.infra-amd64.yml](/docker/docker-compose.infra-amd64.yml) file for requirements.
for arm architecture, use [docker-compose.infra-arm64.yml](/docker/docker-compose.infra-arm64.yml) file
### Docker Hub Images
We publish two images to https://hub.docker.com at every release.
#### [Web Admin Frontend](https://hub.docker.com/r/line/abc-user-feedback-web)
```bash
docker pull line/abc-user-feedback-web
```
#### [API Backend](https://hub.docker.com/r/line/abc-user-feedback-api)
```bash
docker pull line/abc-user-feedback-api
```
## Configuration
### Frontend
:point_right: [Go to Frontend README](./apps/web/README.md)
You can configure the frontend for session password, maximum time span to query, etc.
### Backend
:point_right: [Go to Backend README](./apps/api/README.md)
You can configure the backend for MySQL, SMTP for email verification, OpenSearch-powered improved search experience, etc.
## Integration
If you want to integrate ABC User Feedback with your service, you can use the following features:
1. RESTful Web API - [API document page](https://line.github.io/abc-user-feedback).
1. Accept images from user - [S3 Integration](./GUIDE.md#image-storage-integration).
1. Webhooks - [Webhook specification](./GUIDE.md#Webhook-Feature).
## Development
### Setup Dev Environment using Command Line Tool without Dependencies
ABC User Feedback supports a command line tool(`auf-cli`) that easily runs both the frontend and backend.
With this command line tool, you can initialize the infrastructure and run the app powered by a pre-configured Docker image. Since the CLI is executable with `npx`, only an `npm` environment is required, and no other dependencies are necessary.
```bash
npx auf-cli init # initialize infrastructure
npx auf-cli start # start app
npx auf-cli stop # stop app
```
Please refer to the following npm package site: https://www.npmjs.com/package/auf-cli
### Setup Dev Environment Manually (Local)
ABC User Feedback is using a monorepo (powered by [TurboRepo](https://turbo.build/)) with multiple apps and packages.
Follow the instructions below to set up a local development environment.
1. Clone the repository and install dependencies:
```bash
git clone https://github.com/line/abc-user-feedback
cd abc-user-feedback
pnpm install
```
2. Spin up all required infrastructure (Mysql, OpenSearch, etc.) using Docker Compose:
```bash
docker-compose -f docker/docker-compose.infra-amd64.yml up -d
```
3. Make an `.env` file in `apps/api` and `apps/web` by referring to `.env.example` ([web environment variables](./apps/web/README.md), [api environment variables](./apps/api/README.md))
4. Apply database migrations:
```bash
cd apps/api
npm run migration:run
```
5. To start developing, run the `dev` target of both of apps in root directory:
```bash
pnpm dev
```
6. Also, you can run the `dev` target of one of apps in root directory:
```bash
# web
pnpm dev:web
# api
pnpm dev:api
```
### Build Docker Image
For your code build, you can build docker image using docker-compose. Please refer to [remote caching](https://turbo.build/repo/docs/core-concepts/remote-caching) and [deploying with docker](https://turbo.build/repo/docs/handbook/deploying-with-docker) using `turborepo`.
```
docker compose -f docker-compose.yml build
```
Then, run docker-compose
```
docker compose -f docker-compose.yml up -d
```
## Contributing Guidelines
Please follow the [contributing guidelines](./CONTRIBUTING.md) to contribute to the project.
## License
```
Copyright 2025 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.
```
See [LICENSE](./LICENSE) for more details.